Guia de início rápido: detetando entidades nomeadas (NER)

  • Artigo

Documentação | de referência Mais exemplos | Pacote (NuGet) | Código fonte da biblioteca

Use este início rápido para criar um aplicativo de reconhecimento de entidade nomeada (NER) com a biblioteca de cliente para .NET. No exemplo a seguir, você criará um aplicativo C# que pode identificar entidades reconhecidas no texto.

Gorjeta

Você pode usar o Language Studio para experimentar os recursos do serviço de idiomas sem precisar escrever código.

Pré-requisitos

Configuração

Criar um recurso do Azure

Para usar o exemplo de código abaixo, você precisará implantar um recurso do Azure. Este recurso conterá uma chave e um ponto de extremidade que você usará para autenticar as chamadas de API enviadas ao serviço de idiomas.

  1. Use o link a seguir para criar um recurso de idioma usando o portal do Azure. Você precisará entrar usando sua assinatura do Azure.

  2. Na tela Selecionar recursos adicionais exibida, selecione Continuar para criar seu recurso.

    Uma captura de tela mostrando opções de recursos adicionais no portal do Azure.

  3. Na tela Criar idioma, forneça as seguintes informações:

    Detalhe Description
    Subscrição A conta de subscrição à qual o seu recurso será associado. Selecione sua assinatura do Azure no menu suspenso.
    Grupo de recursos Um grupo de recursos é um contêiner que armazena os recursos criados. Selecione Criar novo para criar um novo grupo de recursos.
    País/Região A localização do seu recurso de idioma. Regiões diferentes podem introduzir latência dependendo da sua localização física, mas não têm impacto na disponibilidade de tempo de execução do seu recurso. Para este início rápido, selecione uma região disponível perto de você ou escolha Leste dos EUA.
    Nome O nome do recurso Idioma. Esse nome também será usado para criar uma URL de ponto de extremidade que seus aplicativos usarão para enviar solicitações de API.
    Escalão de preço A camada de preço para seu recurso de idioma. Você pode usar a camada F0 gratuita para experimentar o serviço e atualizar mais tarde para uma camada paga para produção.

    Uma captura de tela mostrando detalhes de criação de recursos no portal do Azure.

  4. Verifique se a caixa de seleção Aviso de IA Responsável está marcada.

  5. Selecione Rever + Criar na parte inferior da página.

  6. No ecrã apresentado, certifique-se de que a validação foi aprovada e de que introduziu as suas informações corretamente. Depois, selecione Criar.

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.

    Uma captura de tela mostrando as próximas etapas após a implantação de um recurso.

  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.

    Uma captura de tela mostrando as chaves e a seção de ponto de extremidade de um recurso.

Criar variáveis de ambiente

Seu aplicativo deve ser autenticado para enviar solicitações de API. Para produção, use uma maneira segura de armazenar e acessar suas credenciais. Neste exemplo, você gravará suas credenciais em variáveis de ambiente na máquina local que executa o aplicativo.

Gorjeta

Não inclua a chave diretamente no seu código e nunca a publique publicamente. Consulte o artigo de segurança dos serviços de IA do Azure para obter mais opções de autenticação, como o Azure Key Vault.

Para definir a variável de ambiente para sua chave de recurso de idioma, abra uma janela de console e siga as instruções para seu sistema operacional e ambiente de desenvolvimento.

  1. Para definir a LANGUAGE_KEY variável de ambiente, substitua your-key por uma das chaves do seu recurso.
  2. Para definir a variável de LANGUAGE_ENDPOINT ambiente, substitua your-endpoint pelo ponto de extremidade do seu recurso.
setx LANGUAGE_KEY your-key

setx LANGUAGE_ENDPOINT your-endpoint

Nota

Se você só precisar acessar as variáveis de ambiente no console em execução atual, poderá definir a variável de ambiente com set em vez de setx.

Depois de adicionar as variáveis de ambiente, talvez seja necessário reiniciar todos os programas em execução que precisarão ler as variáveis de ambiente, incluindo a janela do console. Por exemplo, se você estiver usando o Visual Studio como editor, reinicie o Visual Studio antes de executar o exemplo.

Criar uma nova aplicação .NET Core

Com o IDE do Visual Studio, crie uma nova aplicação de consola .NET Core. Isso cria um projeto "Hello World" com um único arquivo de origem C#: program.cs.

Instale a biblioteca de cliente, clicando com o botão direito do rato na solução no Explorador de Soluções e selecionando Gerir Pacotes NuGet. No gerenciador de pacotes que é aberto, selecione Procurar e procure Azure.AI.TextAnalytics. Selecione a versão 5.2.0 e, em seguida, Instalar. Também pode utilizar a Consola do Gestor de Pacotes.

Exemplo de código

Copie o código a seguir para o arquivo program.cs e execute o código.

using Azure;
using System;
using Azure.AI.TextAnalytics;

namespace Example
{
    class Program
    {
        // This example requires environment variables named "LANGUAGE_KEY" and "LANGUAGE_ENDPOINT"
        static string languageKey = Environment.GetEnvironmentVariable("LANGUAGE_KEY");
        static string languageEndpoint = Environment.GetEnvironmentVariable("LANGUAGE_ENDPOINT");

        private static readonly AzureKeyCredential credentials = new AzureKeyCredential(languageKey);
        private static readonly Uri endpoint = new Uri(languageEndpoint);
        
        // Example method for extracting named entities from text 
        static void EntityRecognitionExample(TextAnalyticsClient client)
        {
            var response = client.RecognizeEntities("I had a wonderful trip to Seattle last week.");
            Console.WriteLine("Named Entities:");
            foreach (var entity in response.Value)
            {
                Console.WriteLine($"\tText: {entity.Text},\tCategory: {entity.Category},\tSub-Category: {entity.SubCategory}");
                Console.WriteLine($"\t\tScore: {entity.ConfidenceScore:F2},\tLength: {entity.Length},\tOffset: {entity.Offset}\n");
            }
        }

        static void Main(string[] args)
        {
            var client = new TextAnalyticsClient(endpoint, credentials);
            EntityRecognitionExample(client);

            Console.Write("Press any key to exit.");
            Console.ReadKey();
        }

    }
}

Saída

Named Entities:
        Text: trip,     Category: Event,        Sub-Category:
                Score: 0.74,    Length: 4,      Offset: 18

        Text: Seattle,  Category: Location,     Sub-Category: GPE
                Score: 1.00,    Length: 7,      Offset: 26

        Text: last week,        Category: DateTime,     Sub-Category: DateRange
                Score: 0.80,    Length: 9,      Offset: 34

Documentação | de referência Mais exemplos | Pacote (Maven) | Código fonte da biblioteca

Use este início rápido para criar um aplicativo de reconhecimento de entidade nomeada (NER) com a biblioteca de cliente para Java. No exemplo a seguir, você criará um aplicativo Java que pode identificar entidades reconhecidas no texto.

Pré-requisitos

Configuração

Criar um recurso do Azure

Para usar o exemplo de código abaixo, você precisará implantar um recurso do Azure. Este recurso conterá uma chave e um ponto de extremidade que você usará para autenticar as chamadas de API enviadas ao serviço de idiomas.

  1. Use o link a seguir para criar um recurso de idioma usando o portal do Azure. Você precisará entrar usando sua assinatura do Azure.

  2. Na tela Selecionar recursos adicionais exibida, selecione Continuar para criar seu recurso.

    Uma captura de tela mostrando opções de recursos adicionais no portal do Azure.

  3. Na tela Criar idioma, forneça as seguintes informações:

    Detalhe Description
    Subscrição A conta de subscrição à qual o seu recurso será associado. Selecione sua assinatura do Azure no menu suspenso.
    Grupo de recursos Um grupo de recursos é um contêiner que armazena os recursos criados. Selecione Criar novo para criar um novo grupo de recursos.
    País/Região A localização do seu recurso de idioma. Regiões diferentes podem introduzir latência dependendo da sua localização física, mas não têm impacto na disponibilidade de tempo de execução do seu recurso. Para este início rápido, selecione uma região disponível perto de você ou escolha Leste dos EUA.
    Nome O nome do recurso Idioma. Esse nome também será usado para criar uma URL de ponto de extremidade que seus aplicativos usarão para enviar solicitações de API.
    Escalão de preço A camada de preço para seu recurso de idioma. Você pode usar a camada F0 gratuita para experimentar o serviço e atualizar mais tarde para uma camada paga para produção.

    Uma captura de tela mostrando detalhes de criação de recursos no portal do Azure.

  4. Verifique se a caixa de seleção Aviso de IA Responsável está marcada.

  5. Selecione Rever + Criar na parte inferior da página.

  6. No ecrã apresentado, certifique-se de que a validação foi aprovada e de que introduziu as suas informações corretamente. Depois, selecione Criar.

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.

    Uma captura de tela mostrando as próximas etapas após a implantação de um recurso.

  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.

    Uma captura de tela mostrando as chaves e a seção de ponto de extremidade de um recurso.

Criar variáveis de ambiente

Seu aplicativo deve ser autenticado para enviar solicitações de API. Para produção, use uma maneira segura de armazenar e acessar suas credenciais. Neste exemplo, você gravará suas credenciais em variáveis de ambiente na máquina local que executa o aplicativo.

Gorjeta

Não inclua a chave diretamente no seu código e nunca a publique publicamente. Consulte o artigo de segurança dos serviços de IA do Azure para obter mais opções de autenticação, como o Azure Key Vault.

Para definir a variável de ambiente para sua chave de recurso de idioma, abra uma janela de console e siga as instruções para seu sistema operacional e ambiente de desenvolvimento.

  1. Para definir a LANGUAGE_KEY variável de ambiente, substitua your-key por uma das chaves do seu recurso.
  2. Para definir a variável de LANGUAGE_ENDPOINT ambiente, substitua your-endpoint pelo ponto de extremidade do seu recurso.
setx LANGUAGE_KEY your-key

setx LANGUAGE_ENDPOINT your-endpoint

Nota

Se você só precisar acessar as variáveis de ambiente no console em execução atual, poderá definir a variável de ambiente com set em vez de setx.

Depois de adicionar as variáveis de ambiente, talvez seja necessário reiniciar todos os programas em execução que precisarão ler as variáveis de ambiente, incluindo a janela do console. Por exemplo, se você estiver usando o Visual Studio como editor, reinicie o Visual Studio antes de executar o exemplo.

Adicionar a biblioteca de cliente

Crie um projeto do Maven no IDE ou ambiente de desenvolvimento da sua preferência. Em seguida, adicione a seguinte dependência ao ficheiro pom.xml do projeto. Pode encontrar a sintaxe de implementação para outras ferramentas de criação online.

<dependencies>
     <dependency>
        <groupId>com.azure</groupId>
        <artifactId>azure-ai-textanalytics</artifactId>
        <version>5.2.0</version>
    </dependency>
</dependencies>

Exemplo de código

Crie um ficheiro Java com o nome Example.java. Abra o arquivo e copie o código abaixo. Em seguida, execute o código.

import com.azure.core.credential.AzureKeyCredential;
import com.azure.ai.textanalytics.models.*;
import com.azure.ai.textanalytics.TextAnalyticsClientBuilder;
import com.azure.ai.textanalytics.TextAnalyticsClient;

public class Example {

    // This example requires environment variables named "LANGUAGE_KEY" and "LANGUAGE_ENDPOINT"
    private static String languageKey = System.getenv("LANGUAGE_KEY");
    private static String languageEndpoint = System.getenv("LANGUAGE_ENDPOINT");

    public static void main(String[] args) {
        TextAnalyticsClient client = authenticateClient(languageKey, languageEndpoint);
        recognizeEntitiesExample(client);
    }
    // Method to authenticate the client object with your key and endpoint
    static TextAnalyticsClient authenticateClient(String key, String endpoint) {
        return new TextAnalyticsClientBuilder()
                .credential(new AzureKeyCredential(key))
                .endpoint(endpoint)
                .buildClient();
    }
    // Example method for recognizing entities in text
    static void recognizeEntitiesExample(TextAnalyticsClient client)
    {
        // The text that needs to be analyzed.
        String text = "I had a wonderful trip to Seattle last week.";
    
        for (CategorizedEntity entity : client.recognizeEntities(text)) {
            System.out.printf(
                "Recognized entity: %s, entity category: %s, entity sub-category: %s, score: %s, offset: %s, length: %s.%n",
                entity.getText(),
                entity.getCategory(),
                entity.getSubcategory(),
                entity.getConfidenceScore(),
                entity.getOffset(),
                entity.getLength());
        }
    }
}

Saída

Recognized entity: trip, entity category: Event, entity sub-category: null, score: 0.74, offset: 18, length: 4.
Recognized entity: Seattle, entity category: Location, entity sub-category: GPE, score: 1.0, offset: 26, length: 7.
Recognized entity: last week, entity category: DateTime, entity sub-category: DateRange, score: 0.8, offset: 34, length: 9.

Documentação | de referência Mais exemplos | Pacote (npm) | Código fonte da biblioteca

Use este guia de início rápido para criar um aplicativo de reconhecimento de entidade nomeada (NER) com a biblioteca de cliente para Node.js. No exemplo a seguir, você cria um aplicativo JavaScript que pode identificar entidades reconhecidas no texto.

Pré-requisitos

Configuração

Criar um recurso do Azure

Para usar o exemplo de código abaixo, você precisará implantar um recurso do Azure. Este recurso conterá uma chave e um ponto de extremidade que você usará para autenticar as chamadas de API enviadas ao serviço de idiomas.

  1. Use o link a seguir para criar um recurso de idioma usando o portal do Azure. Você precisará entrar usando sua assinatura do Azure.

  2. Na tela Selecionar recursos adicionais exibida, selecione Continuar para criar seu recurso.

    Uma captura de tela mostrando opções de recursos adicionais no portal do Azure.

  3. Na tela Criar idioma, forneça as seguintes informações:

    Detalhe Description
    Subscrição A conta de subscrição à qual o seu recurso será associado. Selecione sua assinatura do Azure no menu suspenso.
    Grupo de recursos Um grupo de recursos é um contêiner que armazena os recursos criados. Selecione Criar novo para criar um novo grupo de recursos.
    País/Região A localização do seu recurso de idioma. Regiões diferentes podem introduzir latência dependendo da sua localização física, mas não têm impacto na disponibilidade de tempo de execução do seu recurso. Para este início rápido, selecione uma região disponível perto de você ou escolha Leste dos EUA.
    Nome O nome do recurso Idioma. Esse nome também será usado para criar uma URL de ponto de extremidade que seus aplicativos usarão para enviar solicitações de API.
    Escalão de preço A camada de preço para seu recurso de idioma. Você pode usar a camada F0 gratuita para experimentar o serviço e atualizar mais tarde para uma camada paga para produção.

    Uma captura de tela mostrando detalhes de criação de recursos no portal do Azure.

  4. Verifique se a caixa de seleção Aviso de IA Responsável está marcada.

  5. Selecione Rever + Criar na parte inferior da página.

  6. No ecrã apresentado, certifique-se de que a validação foi aprovada e de que introduziu as suas informações corretamente. Depois, selecione Criar.

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.

    Uma captura de tela mostrando as próximas etapas após a implantação de um recurso.

  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.

    Uma captura de tela mostrando as chaves e a seção de ponto de extremidade de um recurso.

Criar variáveis de ambiente

Seu aplicativo deve ser autenticado para enviar solicitações de API. Para produção, use uma maneira segura de armazenar e acessar suas credenciais. Neste exemplo, você gravará suas credenciais em variáveis de ambiente na máquina local que executa o aplicativo.

Gorjeta

Não inclua a chave diretamente no seu código e nunca a publique publicamente. Consulte o artigo de segurança dos serviços de IA do Azure para obter mais opções de autenticação, como o Azure Key Vault.

Para definir a variável de ambiente para sua chave de recurso de idioma, abra uma janela de console e siga as instruções para seu sistema operacional e ambiente de desenvolvimento.

  1. Para definir a LANGUAGE_KEY variável de ambiente, substitua your-key por uma das chaves do seu recurso.
  2. Para definir a variável de LANGUAGE_ENDPOINT ambiente, substitua your-endpoint pelo ponto de extremidade do seu recurso.
setx LANGUAGE_KEY your-key

setx LANGUAGE_ENDPOINT your-endpoint

Nota

Se você só precisar acessar as variáveis de ambiente no console em execução atual, poderá definir a variável de ambiente com set em vez de setx.

Depois de adicionar as variáveis de ambiente, talvez seja necessário reiniciar todos os programas em execução que precisarão ler as variáveis de ambiente, incluindo a janela do console. Por exemplo, se você estiver usando o Visual Studio como editor, reinicie o Visual Studio antes de executar o exemplo.

Criar uma nova aplicação Node.js

Numa janela de consola (como cmd, PowerShell ou Bash), crie um novo diretório para a sua aplicação e navegue para a mesma.

mkdir myapp 

cd myapp

Execute o comando npm init para criar uma aplicação de nó com um ficheiro package.json.

npm init

Instalar a biblioteca de cliente

Instale o pacote npm:

npm install @azure/ai-language-text

Exemplo de código

Abra o arquivo e copie o código abaixo. Em seguida, execute o código.

"use strict";

const { TextAnalyticsClient, AzureKeyCredential } = require("@azure/ai-text-analytics");

// This example requires environment variables named "LANGUAGE_KEY" and "LANGUAGE_ENDPOINT"
const key = process.env.LANGUAGE_KEY;
const endpoint = process.env.LANGUAGE_ENDPOINT;

//an example document for entity recognition
const documents = [ "Microsoft was founded by Bill Gates and Paul Allen on April 4, 1975, to develop and sell BASIC interpreters for the Altair 8800"];

//example of how to use the client library to recognize entities in a document.
async function main() {
    console.log("== NER sample ==");
  
    const client = new TextAnalysisClient(endpoint, new AzureKeyCredential(key));
  
    const results = await client.analyze("EntityRecognition", documents);
  
    for (const result of results) {
      console.log(`- Document ${result.id}`);
      if (!result.error) {
        console.log("\tRecognized Entities:");
        for (const entity of result.entities) {
          console.log(`\t- Entity ${entity.text} of type ${entity.category}`);
        }
      } else console.error("\tError:", result.error);
    }
  }

//call the main function
main().catch((err) => {
    console.error("The sample encountered an error:", err);
});

Saída

Document ID: 0
        Name: Microsoft         Category: Organization  Subcategory: N/A
        Score: 0.29
        Name: Bill Gates        Category: Person        Subcategory: N/A
        Score: 0.78
        Name: Paul Allen        Category: Person        Subcategory: N/A
        Score: 0.82
        Name: April 4, 1975     Category: DateTime      Subcategory: Date
        Score: 0.8
        Name: 8800      Category: Quantity      Subcategory: Number
        Score: 0.8
Document ID: 1
        Name: 21        Category: Quantity      Subcategory: Number
        Score: 0.8
        Name: Seattle   Category: Location      Subcategory: GPE
        Score: 0.25

Documentação | de referência Mais exemplos | Pacote (PyPi) | Código fonte da biblioteca

Use este início rápido para criar um aplicativo de reconhecimento de entidade nomeada (NER) com a biblioteca de cliente para Python. No exemplo a seguir, você cria um aplicativo Python que pode identificar entidades reconhecidas no texto.

Pré-requisitos

Configuração

Instalar a biblioteca de cliente

Depois de instalar o Python, pode instalar a biblioteca de cliente com:

pip install azure-ai-textanalytics==5.2.0

Exemplo de código

Crie um novo arquivo Python e copie o código abaixo. Em seguida, execute o código.

# This example requires environment variables named "LANGUAGE_KEY" and "LANGUAGE_ENDPOINT"
language_key = os.environ.get('LANGUAGE_KEY')
language_endpoint = os.environ.get('LANGUAGE_ENDPOINT')

from azure.ai.textanalytics import TextAnalyticsClient
from azure.core.credentials import AzureKeyCredential

# Authenticate the client using your key and endpoint 
def authenticate_client():
    ta_credential = AzureKeyCredential(language_key)
    text_analytics_client = TextAnalyticsClient(
            endpoint=language_endpoint, 
            credential=ta_credential)
    return text_analytics_client

client = authenticate_client()

# Example function for recognizing entities from text
def entity_recognition_example(client):

    try:
        documents = ["I had a wonderful trip to Seattle last week."]
        result = client.recognize_entities(documents = documents)[0]

        print("Named Entities:\n")
        for entity in result.entities:
            print("\tText: \t", entity.text, "\tCategory: \t", entity.category, "\tSubCategory: \t", entity.subcategory,
                    "\n\tConfidence Score: \t", round(entity.confidence_score, 2), "\tLength: \t", entity.length, "\tOffset: \t", entity.offset, "\n")

    except Exception as err:
        print("Encountered exception. {}".format(err))
entity_recognition_example(client)

Saída

Named Entities:

    Text:    trip   Category:        Event  SubCategory:     None
    Confidence Score:        0.74   Length:          4      Offset:          18

    Text:    Seattle        Category:        Location       SubCategory:     GPE
    Confidence Score:        1.0    Length:          7      Offset:          26

    Text:    last week      Category:        DateTime       SubCategory:     DateRange
    Confidence Score:        0.8    Length:          9      Offset:          34

Documentação de referência

Use este guia de início rápido para enviar solicitações de Reconhecimento de Entidade Nomeada (NER) usando a API REST. No exemplo a seguir, você usará cURL para identificar entidades reconhecidas no texto.

Pré-requisitos

Configuração

Criar um recurso do Azure

Para usar o exemplo de código abaixo, você precisará implantar um recurso do Azure. Este recurso conterá uma chave e um ponto de extremidade que você usará para autenticar as chamadas de API enviadas ao serviço de idiomas.

  1. Use o link a seguir para criar um recurso de idioma usando o portal do Azure. Você precisará entrar usando sua assinatura do Azure.

  2. Na tela Selecionar recursos adicionais exibida, selecione Continuar para criar seu recurso.

    Uma captura de tela mostrando opções de recursos adicionais no portal do Azure.

  3. Na tela Criar idioma, forneça as seguintes informações:

    Detalhe Description
    Subscrição A conta de subscrição à qual o seu recurso será associado. Selecione sua assinatura do Azure no menu suspenso.
    Grupo de recursos Um grupo de recursos é um contêiner que armazena os recursos criados. Selecione Criar novo para criar um novo grupo de recursos.
    País/Região A localização do seu recurso de idioma. Regiões diferentes podem introduzir latência dependendo da sua localização física, mas não têm impacto na disponibilidade de tempo de execução do seu recurso. Para este início rápido, selecione uma região disponível perto de você ou escolha Leste dos EUA.
    Nome O nome do recurso Idioma. Esse nome também será usado para criar uma URL de ponto de extremidade que seus aplicativos usarão para enviar solicitações de API.
    Escalão de preço A camada de preço para seu recurso de idioma. Você pode usar a camada F0 gratuita para experimentar o serviço e atualizar mais tarde para uma camada paga para produção.

    Uma captura de tela mostrando detalhes de criação de recursos no portal do Azure.

  4. Verifique se a caixa de seleção Aviso de IA Responsável está marcada.

  5. Selecione Rever + Criar na parte inferior da página.

  6. No ecrã apresentado, certifique-se de que a validação foi aprovada e de que introduziu as suas informações corretamente. Depois, selecione Criar.

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.

    Uma captura de tela mostrando as próximas etapas após a implantação de um recurso.

  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.

    Uma captura de tela mostrando as chaves e a seção de ponto de extremidade de um recurso.

Criar variáveis de ambiente

Seu aplicativo deve ser autenticado para enviar solicitações de API. Para produção, use uma maneira segura de armazenar e acessar suas credenciais. Neste exemplo, você gravará suas credenciais em variáveis de ambiente na máquina local que executa o aplicativo.

Gorjeta

Não inclua a chave diretamente no seu código e nunca a publique publicamente. Consulte o artigo de segurança dos serviços de IA do Azure para obter mais opções de autenticação, como o Azure Key Vault.

Para definir a variável de ambiente para sua chave de recurso de idioma, abra uma janela de console e siga as instruções para seu sistema operacional e ambiente de desenvolvimento.

  1. Para definir a LANGUAGE_KEY variável de ambiente, substitua your-key por uma das chaves do seu recurso.
  2. Para definir a variável de LANGUAGE_ENDPOINT ambiente, substitua your-endpoint pelo ponto de extremidade do seu recurso.
setx LANGUAGE_KEY your-key

setx LANGUAGE_ENDPOINT your-endpoint

Nota

Se você só precisar acessar as variáveis de ambiente no console em execução atual, poderá definir a variável de ambiente com set em vez de setx.

Depois de adicionar as variáveis de ambiente, talvez seja necessário reiniciar todos os programas em execução que precisarão ler as variáveis de ambiente, incluindo a janela do console. Por exemplo, se você estiver usando o Visual Studio como editor, reinicie o Visual Studio antes de executar o exemplo.

Criar um arquivo JSON com o corpo da solicitação de exemplo

Em um editor de códigos, crie um novo arquivo chamado test_ner_payload.json e copie o exemplo JSON a seguir. Esta solicitação de exemplo será enviada para a API na próxima etapa.

{
    "kind": "EntityRecognition",
    "parameters": {
        "modelVersion": "latest"
    },
    "analysisInput":{
        "documents":[
            {
                "id":"1",
                "language": "en",
                "text": "I had a wonderful trip to Seattle last week."
            }
        ]
    }
}

Guarde test_ner_payload.json algures no seu computador. Por exemplo, o seu ambiente de trabalho.

Enviar uma solicitação de API de reconhecimento de entidade nomeada

Use os comandos a seguir para enviar a solicitação de API usando o programa que você está usando. Copie o comando para o terminal e execute-o.

parâmetro Description
-X POST <endpoint> Especifica seu ponto de extremidade para acessar a API.
-H Content-Type: application/json O tipo de conteúdo para enviar dados JSON.
-H "Ocp-Apim-Subscription-Key:<key> Especifica a chave para acessar a API.
-d <documents> O JSON que contém os documentos que você deseja enviar.

Substitua C:\Users\<myaccount>\Desktop\test_ner_payload.json pelo local do arquivo de solicitação JSON de exemplo criado na etapa anterior.

Linha de comandos

curl -X POST "%LANGUAGE_ENDPOINT%/language/:analyze-text?api-version=2022-05-01" ^
-H "Content-Type: application/json" ^
-H "Ocp-Apim-Subscription-Key: %LANGUAGE_KEY%" ^
-d "@C:\Users\<myaccount>\Desktop\test_ner_payload.json"

PowerShell

curl.exe -X POST $env:LANGUAGE_ENDPOINT/language/:analyze-text?api-version=2022-05-01 `
-H "Content-Type: application/json" `
-H "Ocp-Apim-Subscription-Key: $env:LANGUAGE_KEY" `
-d "@C:\Users\<myaccount>\Desktop\test_ner_payload.json"

Resposta JSON

Nota

  • A API geralmente disponível e a API de visualização atual têm formatos de resposta diferentes, consulte o artigo de mapeamento de api geralmente disponível para visualização.
  • A API de visualização está disponível startin a partir da versão 2023-04-15-previewda API.
{
	"kind": "EntityRecognitionResults",
	"results": {
		"documents": [{
			"id": "1",
			"entities": [{
				"text": "trip",
				"category": "Event",
				"offset": 18,
				"length": 4,
				"confidenceScore": 0.74
			}, {
				"text": "Seattle",
				"category": "Location",
				"subcategory": "GPE",
				"offset": 26,
				"length": 7,
				"confidenceScore": 1.0
			}, {
				"text": "last week",
				"category": "DateTime",
				"subcategory": "DateRange",
				"offset": 34,
				"length": 9,
				"confidenceScore": 0.8
			}],
			"warnings": []
		}],
		"errors": [],
		"modelVersion": "2021-06-01"
	}
}

Clean up resources (Limpar recursos)

Se quiser limpar e remover uma assinatura de serviços do Azure AI, você pode excluir o recurso ou grupo de recursos. A exclusão do grupo de recursos também exclui quaisquer outros recursos associados a ele.

Próximos passos