Guia de início rápido: usando a biblioteca de cliente Key Phrase Extraction e a API REST

Artigo
03/15/2024

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

Use este guia de início rápido para criar um aplicativo de extração de frase-chave com a biblioteca de cliente para .NET. No exemplo a seguir, você criará um aplicativo C# que pode identificar palavras-chave e frases encontradas 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

Subscrição do Azure - Criar uma gratuitamente
O IDE do Visual Studio
Depois de ter sua assinatura do Azure, crie um recurso de idioma no portal do Azure para obter sua chave e ponto de extremidade. Depois de implantar, selecione Ir para recurso.
- Você precisará da chave e do ponto de extremidade do recurso criado para conectar seu aplicativo à API. Você colará sua chave e ponto de extremidade no código abaixo mais adiante no início rápido.
- Você pode usar o nível de preço gratuito (Free F0) para experimentar o serviço e atualizar posteriormente para um nível pago para produção.
Para usar o recurso Analisar, você precisará de um recurso de idioma com o nível de preço padrão (S).

Configuração

Criar uma nova aplicação .NET Core

Com o IDE do Visual Studio, crie uma nova aplicação de consola .NET Core. Isto irá criar um projeto "Hello World" com um único ficheiro 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 . Lembre-se de substituir a key variável pela chave do seu recurso e substituir a endpoint variável pelo ponto de extremidade do seu recurso. Em seguida, execute o código.

Importante

Aceda ao portal do Azure. Se o recurso de idioma criado na seção Pré-requisitos for implantado com êxito, clique no botão Ir para recurso em Próximas etapas. Você pode encontrar sua chave e ponto de extremidade navegando até a página Chaves e Ponto Final do seu recurso, em Gerenciamento de Recursos.

Importante

Lembre-se de remover a chave do seu código quando terminar e nunca publicá-la publicamente. Para produção, use uma maneira segura de armazenar e acessar suas credenciais, como o Azure Key Vault. Consulte o artigo de segurança dos serviços de IA do Azure para obter mais informações.

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

namespace KeyPhraseExtractionExample
{
    class Program
    {
        private static readonly AzureKeyCredential credentials = new AzureKeyCredential("replace-with-your-key-here");
        private static readonly Uri endpoint = new Uri("replace-with-your-endpoint-here");

        // Example method for extracting key phrases from text
        static void KeyPhraseExtractionExample(TextAnalyticsClient client)
        {
            var response = client.ExtractKeyPhrases(@"Dr. Smith has a very modern medical office, and she has great staff.");

            // Printing key phrases
            Console.WriteLine("Key phrases:");

            foreach (string keyphrase in response.Value)
            {
                Console.WriteLine($"\t{keyphrase}");
            }
        }

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

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

    }
}

Saída

Key phrases:
    modern medical office
    Dr. Smith
    great staff

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

Use este início rápido para criar um aplicativo de extração de frase-chave com a biblioteca cliente para Java. No exemplo a seguir, você criará um aplicativo Java que pode identificar palavras-chave e frases encontradas 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

Subscrição do Azure - Criar uma gratuitamente
Java Development Kit (JDK) com a versão 8 ou superior
Depois de ter sua assinatura do Azure, crie um recurso de idioma no portal do Azure para obter sua chave e ponto de extremidade. Depois de implantar, selecione Ir para recurso.
- Você precisará da chave e do ponto de extremidade do recurso criado para conectar seu aplicativo à API. Você colará sua chave e ponto de extremidade no código abaixo mais adiante no início rápido.
- Você pode usar o nível de preço gratuito (Free F0) para experimentar o serviço e atualizar posteriormente para um nível pago para produção.
Para usar o recurso Analisar, você precisará de um recurso de idioma com o nível de preço padrão (S).

Configuração

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. Lembre-se de substituir a key variável pela chave do seu recurso e substituir a endpoint variável pelo ponto de extremidade do seu recurso. Em seguida, execute o código.

Importante

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


public class Example {

    private static String KEY = "replace-with-your-key-here";
    private static String ENDPOINT = "replace-with-your-endpoint-here";

    public static void main(String[] args) {
        TextAnalyticsClient client = authenticateClient(KEY, ENDPOINT);
        extractKeyPhrasesExample(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 extracting key phrases from text
    static void extractKeyPhrasesExample(TextAnalyticsClient client)
    {
        // The text to be analyzed
        String text = "Dr. Smith has a very modern medical office, and she has great staff.";

        System.out.printf("Recognized phrases: %n");
        for (String keyPhrase : client.extractKeyPhrases(text)) {
            System.out.printf("%s%n", keyPhrase);
        }
    }
}

Saída

Recognized phrases: 

modern medical office
Dr. Smith
great staff

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

Use este guia de início rápido para criar um aplicativo de extração de frase-chave com a biblioteca de cliente para Node.js. No exemplo a seguir, você criará um aplicativo JavaScript que pode identificar palavras-chave e frases encontradas 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

Subscrição do Azure - Criar uma gratuitamente
Node.js v14 LTS ou posterior
Depois de ter sua assinatura do Azure, crie um recurso de idioma no portal do Azure para obter sua chave e ponto de extremidade. Depois de implantar, selecione Ir para recurso.
- Você precisará da chave e do ponto de extremidade do recurso criado para conectar seu aplicativo à API. Você colará sua chave e ponto de extremidade no código abaixo mais adiante no início rápido.
- Você pode usar o nível de preço gratuito (Free F0) para experimentar o serviço e atualizar posteriormente para um nível pago para produção.
Para usar o recurso Analisar, você precisará de um recurso de idioma com o nível de preço padrão (S).

Configuração

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. Lembre-se de substituir a key variável pela chave do seu recurso e substituir a endpoint variável pelo ponto de extremidade do seu recurso. Em seguida, execute o código.

Importante

"use strict";

const { TextAnalysisClient, AzureKeyCredential } = require("@azure/ai-language-text");
const key = '<paste-your-key-here>';
const endpoint = '<paste-your-endpoint-here>';

//example sentence for performing key phrase extraction
const documents = ["Dr. Smith has a very modern medical office, and she has great staff."];

//example of how to use the client to perform entity linking on a document
async function main() {
    console.log("== key phrase extraction sample ==");
  
    const client = new TextAnalysisClient(endpoint, new AzureKeyCredential(key));
  
    const results = await client.analyze("KeyPhraseExtraction", documents);
  
    for (const result of results) {
      console.log(`- Document ${result.id}`);
      if (!result.error) {
        console.log("\tKey phrases:");
        for (const phrase of result.keyPhrases) {
          console.log(`\t- ${phrase}`);
        }
      } else {
        console.error("  Error:", result.error);
      }
    }
  }
  
  main().catch((err) => {
    console.error("The sample encountered an error:", err);
  });

Saída

== key phrase extraction sample ==
- Document 0
    Key phrases:
    - modern medical office
    - Dr. Smith
    - great staff

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

Use este início rápido para criar um aplicativo de extração de frase-chave com a biblioteca de cliente para Python. No exemplo a seguir, você criará um aplicativo Python que pode identificar palavras-chave e frases encontradas 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

Subscrição do Azure - Criar uma gratuitamente
Python 3.8 ou posterior
Depois de ter sua assinatura do Azure, crie um recurso de idioma no portal do Azure para obter sua chave e ponto de extremidade. Depois de implantar, selecione Ir para recurso.
- Você precisará da chave e do ponto de extremidade do recurso criado para conectar seu aplicativo à API. Você colará sua chave e ponto de extremidade no código abaixo mais adiante no início rápido.
- Você pode usar o nível de preço gratuito (Free F0) para experimentar o serviço e atualizar posteriormente para um nível pago para produção.
Para usar o recurso Analisar, você precisará de um recurso de idioma com o nível de preço padrão (S).

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. Lembre-se de substituir a key variável pela chave do seu recurso e substituir a endpoint variável pelo ponto de extremidade do seu recurso. Em seguida, execute o código.

Importante

key = "paste-your-key-here"
endpoint = "paste-your-endpoint-here"

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(key)
    text_analytics_client = TextAnalyticsClient(
            endpoint=endpoint, 
            credential=ta_credential)
    return text_analytics_client

client = authenticate_client()

def key_phrase_extraction_example(client):

    try:
        documents = ["Dr. Smith has a very modern medical office, and she has great staff."]

        response = client.extract_key_phrases(documents = documents)[0]

        if not response.is_error:
            print("\tKey Phrases:")
            for phrase in response.key_phrases:
                print("\t\t", phrase)
        else:
            print(response.id, response.error)

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

Saída

Key Phrases:
    modern medical office
    Dr. Smith
    great staff

Documentação de referência

Use este guia de início rápido para enviar solicitações de extração de frase-chave usando a API REST. No exemplo a seguir, você usará cURL para identificar palavras-chave e frases encontradas 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

Subscrição do Azure - Criar uma gratuitamente
A versão atual do cURL.
Depois de ter sua assinatura do Azure, crie um recurso de idioma no portal do Azure para obter sua chave e ponto de extremidade. Depois de implantar, selecione Ir para recurso.
- Você precisará da chave e do ponto de extremidade do recurso criado para conectar seu aplicativo à API. Você colará sua chave e ponto de extremidade no código abaixo mais adiante no início rápido.
- Você pode usar o nível de preço gratuito (Free F0) para experimentar o serviço e atualizar posteriormente para um nível pago para produção.

Nota

Os exemplos de BASH a seguir usam o caractere de continuação de \ linha. Se o console ou terminal usar um caractere de continuação de linha diferente, use esse caractere.
Você pode encontrar exemplos específicos de idiomas no GitHub.
Vá para o portal do Azure e localize a chave e o ponto de extremidade para o recurso Language que você criou nos pré-requisitos. Eles estarão localizados na página de chave e ponto final do recurso, em gerenciamento de recursos. Em seguida, substitua as cadeias de caracteres no código abaixo por sua chave e ponto de extremidade. Para chamar a API, você precisa das seguintes informações:

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.

Os seguintes comandos cURL são executados a partir de um shell BASH. Edite esses comandos com seu próprio nome de recurso, chave de recurso e valores JSON.

Extração de expressões-chave

Copie o comando para um editor de texto.
Faça as seguintes alterações no comando onde necessário:
1. Substitua o valor <your-language-resource-key> pela sua chave.
2. Substitua a primeira parte da URL <your-language-resource-endpoint> da solicitação pela URL do ponto de extremidade.
Abra uma janela da linha de comandos.
Cole o comando a partir do editor de texto na janela da linha de comandos e, em seguida, execute o comando.

curl -i -X POST https://<your-language-resource-endpoint>/language/:analyze-text?api-version=2022-05-01 \
-H "Content-Type: application/json" \
-H "Ocp-Apim-Subscription-Key: <your-language-resource-key>" \
-d \
'
{
    "kind": "KeyPhraseExtraction",
    "parameters": {
        "modelVersion": "latest"
    },
    "analysisInput":{
        "documents":[
            {
                "id":"1",
                "language":"en",
                "text": "Dr. Smith has a very modern medical office, and she has great staff."
            }
        ]
    }
}
'

Resposta JSON

{
	"kind": "KeyPhraseExtractionResults",
	"results": {
		"documents": [{
			"id": "1",
			"keyPhrases": ["modern medical office", "Dr. Smith", "great staff"],
			"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

Descrição geral da extração de expressões-chave

Guia de início rápido: usando a biblioteca de cliente Key Phrase Extraction e a API REST

Pré-requisitos

Configuração

Criar uma nova aplicação .NET Core

Exemplo de código

Saída

Pré-requisitos

Configuração

Adicionar a biblioteca de cliente

Exemplo de código

Saída

Pré-requisitos

Configuração

Criar uma nova aplicação Node.js

Instalar a biblioteca de cliente

Exemplo de código

Saída

Pré-requisitos

Configuração

Instalar a biblioteca de cliente

Exemplo de código

Saída

Pré-requisitos

Extração de expressões-chave

Resposta JSON

Clean up resources (Limpar recursos)

Próximos passos

Recursos adicionais