Início Rápido: Como usar a biblioteca Detecção de Idioma cliente e a API REST

Artigo
04/12/2024

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

Use este início rápido para criar um aplicativo de detecção de linguagem com a biblioteca de clientes para .NET. No exemplo a seguir, você cria um aplicativo C# que pode identificar o idioma no qual um exemplo de texto foi escrito.

Dica

Use o Language Studio para experimentar os recursos do serviço de linguagem sem a necessidade de gravar o código.

Pré-requisitos

Assinatura do Azure – Criar uma gratuitamente
O IDE do Visual Studio
Após obter sua assinatura do Azure, crie um recurso de Linguagem no portal do Azure para obter a chave e o ponto de extremidade. Após a implantação, selecione Ir para recurso.
- Você precisa da chave e do ponto de extremidade do recurso criado 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.
- Use o tipo de preço gratuito (Free F0) para experimentar o serviço e atualizar mais tarde para um nível pago para produção.
Para usar o recurso Analisar, você precisa de um recurso de linguagem com o tipo de preço S (Standard).

Configurando

Criar um aplicativo .NET Core

Usando o IDE do Visual Studio, crie um aplicativo de console do .NET Core. Isso criará um projeto "Olá, Mundo" com um arquivo de origem C#: program.cs.

Instale a biblioteca de cliente clicando com o botão direito do mouse na solução no Gerenciador de Soluções e selecionando Gerenciar Pacotes do NuGet. No gerenciador de pacotes que é aberto, selecione Procurar e pesquise por Azure.AI.TextAnalytics. Selecione a versão 5.2.0 e, em seguida, Instalar. Você também pode usar o Console do Gerenciador de Pacotes.

Exemplo de código

Copie o código a seguir para o arquivo program.cs. Lembre-se de substituir a variável key pela chave do recurso e substituir a variável endpoint pelo ponto de extremidade do recurso. Depois, execute o código.

Importante

Vá para o portal do Azure. Se o recurso de Linguagem que você criou na seção Pré-requisitos tiver sido implantado com êxito, clique no botão Ir para o recurso em Próximas Etapas. Para encontrar a chave e o ponto de extremidade, acesse a página Chaves e Ponto de Extremidade do recurso em Gerenciamento de Recursos.

Importante

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

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

namespace LanguageDetectionExample
{
    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");

        // Example method for detecting the language of text
        static void LanguageDetectionExample(TextAnalyticsClient client)
        {
            DetectedLanguage detectedLanguage = client.DetectLanguage("Ce document est rédigé en Français.");
            Console.WriteLine("Language:");
            Console.WriteLine($"\t{detectedLanguage.Name},\tISO-6391: {detectedLanguage.Iso6391Name}\n");
        }

        static void Main(string[] args)
        {
            var client = new TextAnalyticsClient(languageEndpoint, languageKey);
            LanguageDetectionExample(client);

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

    }
}

Saída

Language:
    French, ISO-6391: fr

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

Use este início rápido para criar um aplicativo de detecção de linguagem com a biblioteca de clientes para Java. No exemplo a seguir, você cria um aplicativo Java que pode identificar o idioma no qual um exemplo de texto foi escrito.

Dica

Use o Language Studio para experimentar os recursos do serviço de linguagem sem a necessidade de gravar o código.

Pré-requisitos

Assinatura do Azure – Criar uma gratuitamente
JDK (Java Development Kit) com a versão 8 ou superior
Após obter sua assinatura do Azure, crie um recurso de Linguagem no portal do Azure para obter a chave e o ponto de extremidade. Após a implantação, selecione Ir para recurso.
- Você precisa da chave e do ponto de extremidade do recurso criado para conectar seu aplicativo à API. Você colará a chave e o ponto de extremidade no código abaixo, mais adiante no início rápido.
- Use o tipo de preço gratuito (Free F0) para experimentar o serviço e atualizar mais tarde para um nível pago para produção.
Para usar o recurso Analisar, você precisa de um recurso de linguagem com o tipo de preço S (Standard).

Configurando

Adicionar a biblioteca de clientes

Crie um projeto Maven no IDE ou no ambiente de desenvolvimento de sua preferência. Em seguida, adicione a dependência a seguir ao arquivo pom.xml do projeto. Você pode encontrar a sintaxe de implementação para outras ferramentas de build 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 arquivo Java chamado Example.java. Abra o arquivo e copie o código abaixo. Lembre-se de substituir a variável key pela chave do recurso e substituir a variável endpoint pelo ponto de extremidade do recurso. Depois, execute o código.

Importante

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);
        detectLanguageExample(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 detecting the language of text
    static void detectLanguageExample(TextAnalyticsClient client)
    {
        // The text to be analyzed.
        String text = "Ce document est rédigé en Français.";

        DetectedLanguage detectedLanguage = client.detectLanguage(text);
        System.out.printf("Detected primary language: %s, ISO 6391 name: %s, score: %.2f.%n",
                detectedLanguage.getName(),
                detectedLanguage.getIso6391Name(),
                detectedLanguage.getConfidenceScore());
    }
}

Saída

Detected primary language: French, ISO 6391 name: fr, score: 1.00.

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

Use este início rápido para criar um aplicativo de detecção de linguagem com a biblioteca de clientes para Node.js. No exemplo a seguir, você cria um aplicativo JavaScript que pode identificar o idioma no qual um exemplo de texto foi escrito.

Dica

Use o Language Studio para experimentar os recursos do serviço de linguagem sem a necessidade de gravar o código.

Pré-requisitos

Assinatura do Azure – Criar uma gratuitamente
Node.js v14 LTS ou posterior
Após obter sua assinatura do Azure, crie um recurso de Linguagem no portal do Azure para obter a chave e o ponto de extremidade. Após a implantação, selecione Ir para recurso.
- Você precisa da chave e do ponto de extremidade do recurso criado para conectar seu aplicativo à API. Você colará a chave e o ponto de extremidade no código abaixo, mais adiante no início rápido.
- Use o tipo de preço gratuito (Free F0) para experimentar o serviço e atualizar mais tarde para um nível pago para produção.
Para usar o recurso Analisar, você precisa de um recurso de linguagem com o tipo de preço S (Standard).

Configurando

Criar um novo aplicativo do Node.js

Em uma janela de console (como cmd, PowerShell ou Bash), crie um novo diretório para seu aplicativo e navegue até ele.

mkdir myapp 

cd myapp

Execute o comando npm init para criar um aplicativo do Node com um arquivo package.json.

npm init

Instalar a biblioteca de clientes

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

Importante

"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;

//Example sentences in different languages to be analyzed
const documents = [
    "This document is written in English.",
    "这是一个用中文写的文件",
];

//Example of how to use the client library to detect language
async function main() {
    console.log("== Language detection sample ==");
  
    const client = new TextAnalysisClient(endpoint, new AzureKeyCredential(key));
  
    const result = await client.analyze("LanguageDetection", documents);
  
    for (const doc of result) {
      if (!doc.error) {
        console.log(
          `ID ${doc.id} - Primary language: ${doc.primaryLanguage.name} (iso6391 name: ${doc.primaryLanguage.iso6391Name})`
        );
      }
    }
}

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

Saída

== Language detection sample ==
ID 0 - Primary language: English (iso6391 name: en)
ID 1 - Primary language: Chinese_Simplified (iso6391 name: zh_chs)

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

Use este início rápido para criar um aplicativo de detecção de linguagem com a biblioteca de clientes para Python. No exemplo a seguir, você cria um aplicativo Python que pode identificar o idioma no qual um exemplo de texto foi escrito.

Dica

Use o Language Studio para experimentar os recursos do serviço de linguagem sem a necessidade de gravar o código.

Pré-requisitos

Assinatura do Azure – Criar uma gratuitamente
Python 3.8 ou posterior
Após obter sua assinatura do Azure, crie um recurso de Linguagem no portal do Azure para obter a chave e o ponto de extremidade. Após a implantação, selecione Ir para recurso.
- Você precisa da chave e do ponto de extremidade do recurso criado para conectar seu aplicativo à API. Você colará a chave e o ponto de extremidade no código abaixo, mais adiante no início rápido.
- Use o tipo de preço gratuito (Free F0) para experimentar o serviço e atualizar mais tarde para um nível pago para produção.
Para usar o recurso Analisar, você precisa de um recurso de linguagem com o tipo de preço S (Standard).

Configurando

Instalar a biblioteca de clientes

Depois de instalar o Python, você pode instalar a biblioteca de clientes 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 variável key pela chave do recurso e substituir a variável endpoint pelo ponto de extremidade do recurso. Depois, execute o código.

Importante


# 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 method for detecting the language of text
def language_detection_example(client):
    try:
        documents = ["Ce document est rédigé en Français."]
        response = client.detect_language(documents = documents, country_hint = 'us')[0]
        print("Language: ", response.primary_language.name)

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

Saída

Language:  French

Documentação de referência

Use este início rápido para enviar solicitações de detecção de linguagem usando a API REST. No exemplo a seguir, você usará o cURL para identificar o idioma em que uma amostra de texto foi escrita.

Pré-requisitos

Assinatura do Azure – Criar uma gratuitamente

Configurando

Criar um recurso do Azure

Será necessário implantar um recurso do Azure para usar o exemplo de código abaixo. Esse recurso conterá uma chave e um ponto de extremidade que você usará para autenticar as chamadas de API enviadas para o serviço de linguagem.

Use o link a seguir para criar um recurso de linguagem usando o portal do Azure. Você precisará se conectar usando sua assinatura do Azure.
Na tela Selecionar recursos adicionais que aparece, selecione Continuar a criar seu recurso.

Na tela Criar linguagem, forneça as seguintes informações:

Detalhe	Descrição
Subscription	A conta de assinatura à qual seu recurso será associado. Selecione a assinatura do Azure no menu suspenso.
Resource group	Um grupo de recursos é um contêiner que armazena os recursos criados por você. Selecione Criar novo para criar um novo grupo de recursos.
Região	O local do recurso de Linguagem. Diferentes regiões podem apresentar latência, dependendo do seu local físico, mas não impactam sobre a disponibilidade de runtime do seu recurso. Neste início rápido, selecione uma região disponível perto de você ou escolha Leste dos EUA.
Nome	O nome para o recurso de linguagem. Esse nome também será usado para criar uma URL de ponto de extremidade e seus aplicativos o usarão para enviar solicitações de API.
Tipo de preço	O tipo de preço do recurso de Linguagem. É possível usar o nível Gratuito F0 para experimentar o serviço e atualizar mais tarde para um nível pago para produção.

Verifique se a caixa de seleção Aviso de IA Responsável está marcada.
Selecione Examinar + Criar na parte inferior da página.
Na tela exibida, verifique se a validação foi aprovada e se você inseriu suas informações corretamente. Em seguida, selecione Criar.

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.

Após a implantação bem-sucedida do recurso de linguagem, clique no botão Acessar recurso em Próximas etapas.
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.

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 no computador local que está executando o aplicativo.

Dica

Não inclua a chave diretamente no código e nunca a divulgue publicamente. Confira 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 da chave de recurso de linguagem, abra uma janela do console e siga as instruções para o seu sistema operacional e ambiente de desenvolvimento.

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

setx LANGUAGE_KEY your-key

setx LANGUAGE_ENDPOINT your-endpoint

Observação

Se for necessário acessar somente as variáveis de ambiente no console em execução no momento, você pode definir a variável de ambiente com set em vez de setx.

Após adicionar as variáveis de ambiente, é aconselhável reiniciar todos os programas em execução que precisarem ler as variáveis de ambiente, incluindo a janela do console. Por exemplo, se estiver usando o Visual Studio como seu editor, reinicie-o antes de executar o exemplo.

export LANGUAGE_KEY=your-key

export LANGUAGE_ENDPOINT=your-endpoint

Depois de adicionar as variáveis de ambiente, execute source ~/.bashrc na janela do console para que as alterações entrem em vigor.

Bash

export LANGUAGE_KEY=your-key

export LANGUAGE_ENDPOINT=your-endpoint

Depois de adicionar as variáveis de ambiente, execute source ~/.bash_profile na janela do console para que as alterações entrem em vigor.

Xcode

Para desenvolvimento em iOS e macOS, defina as variáveis de ambiente no Xcode. Por exemplo, siga estas etapas para definir a variável de ambiente no Xcode 13.4.1.

Selecione Produto>Esquema>Editar esquema
Selecione Argumentos na página Executar (Execução de Depuração)
Em Variáveis de Ambiente, selecione o sinal de adição (+) para adicionar uma nova variável de ambiente.
Insira LANGUAGE_KEY para o Nome e insira a chave de recurso de linguagem para o Valor.
Realize essas etapas para o ponto de extremidade de recurso. Nomear a nova variável de ambiente LANGUAGE_ENDPOINT.

Para obter mais opções de configuração, consulte a documentação do Xcode.

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

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

Observação

Você pode encontrar exemplos específicos de cada linguagem de programação no GitHub.

{
    "kind": "LanguageDetection",
    "parameters": {
        "modelVersion": "latest"
    },
    "analysisInput":{
        "documents":[
            {
                "id":"1",
                "text": "This is a document written in English."
            }
        ]
    }
}

Salve test_detection_payload.json em algum lugar no seu computador. Por exemplo, sua área de trabalho.

Enviar uma solicitação de detecção de idioma

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	Descrição
`-X POST <endpoint>`	Especifica o ponto de extremidade para acessar a API.
`-H Content-Type: application/json`	Tipo de conteúdo para enviar dados JSON.
`-H "Ocp-Apim-Subscription-Key:<key>`	Especifica a chave para acessar a API.
`-d <documents>`	JSON contendo os documentos que você deseja enviar.

Substitua C:\Users\<myaccount>\Desktop\test_detection_payload.json pela localização do arquivo da solicitação JSON de exemplo criado na etapa anterior.

Prompt de comando

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

PowerShell

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

Use os comandos a seguir para enviar a solicitação de API usando o programa que você está usando. Substitua /home/mydir/test_detection_payload.json pela localização do arquivo da solicitação JSON de exemplo criado na etapa anterior.

curl -X POST $LANGUAGE_ENDPOINT/language/:analyze-text?api-version=2023-11-15-preview \
-H "Content-Type: application/json" \
-H "Ocp-Apim-Subscription-Key: $LANGUAGE_KEY" \
-d "@/home/mydir/test_sentiment_payload.json"

curl -X POST $LANGUAGE_ENDPOINT/language/:analyze-text?api-version=2023-11-15-preview \
-H "Content-Type: application/json" \
-H "Ocp-Apim-Subscription-Key: $LANGUAGE_KEY" \
-d "@/home/mydir/test_detection_payload.json"

Resposta JSON

{
    "kind": "LanguageDetectionResults",
    "results": {
        "documents": [
            {
                "id": "1",
                "detectedLanguage": {
                    "name": "English",
                    "iso6391Name": "en",
                    "confidenceScore": 1.0,
                    "script": "Latin",
                    "scriptCode": "Latn"
                },
                "warnings": []
            }
        ],
        "errors": [],
        "modelVersion": "2023-12-01"
    }
}

Use os comandos a seguir para excluir as variáveis de ambiente que você criou para esse início rápido.

reg delete "HKCU\Environment" /v LANGUAGE_KEY /f

reg delete "HKCU\Environment" /v LANGUAGE_ENDPOINT /f

unset LANGUAGE_KEY

unset LANGUAGE_ENDPOINT

unset LANGUAGE_KEY

unset LANGUAGE_ENDPOINT

Limpar os recursos

Se quiser limpar e remover uma assinatura dos Serviços de IA do Azure, você poderá excluir o recurso ou grupo de recursos. Excluir o grupo de recursos também exclui todos os recursos associados a ele.

Próximas etapas

Visão geral da detecção de idioma

Início Rápido: Como usar a biblioteca Detecção de Idioma cliente e a API REST

Pré-requisitos

Configurando

Criar um aplicativo .NET Core

Exemplo de código

Saída

Pré-requisitos

Configurando

Adicionar a biblioteca de clientes

Exemplo de código

Saída

Pré-requisitos

Configurando

Criar um novo aplicativo do Node.js

Instalar a biblioteca de clientes

Exemplo de código

Saída

Pré-requisitos

Configurando

Instalar a biblioteca de clientes

Exemplo de código

Saída

Pré-requisitos

Configurando

Criar um recurso do Azure

Obter chave e ponto de extremidade

Criar variáveis de ambiente

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

Enviar uma solicitação de detecção de idioma

Prompt de comando

PowerShell

Resposta JSON

Limpar os recursos

Próximas etapas

Recursos adicionais