Guia de início rápido: usando a biblioteca de cliente de deteção de idioma e a API REST

Artigo
04/11/2024

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 deteção de idioma com a biblioteca de cliente para .NET. No exemplo a seguir, você cria um aplicativo C# que pode identificar o idioma em que um exemplo de texto foi escrito.

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ê precisa da chave e do ponto de extremidade do recurso criado para conectar seu aplicativo à API. Você cola sua chave e ponto de extremidade no código mais tarde 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ê precisa 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. 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 . 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 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 exemplos | Pacote (Maven) | Código fonte da biblioteca

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

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ê precisa da chave e do ponto de extremidade do recurso criado para conectar seu aplicativo à API. Você cola 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ê precisa 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.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 exemplos | Pacote (npm) | Código fonte da biblioteca

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

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ê precisa da chave e do ponto de extremidade do recurso criado para conectar seu aplicativo à API. Você cola 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ê precisa 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 { 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 exemplos | Pacote (PyPi) | Código fonte da biblioteca

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

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ê precisa da chave e do ponto de extremidade do recurso criado para conectar seu aplicativo à API. Você cola 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ê precisa 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


# 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 guia de início rápido para enviar solicitações de deteção de idioma usando a API REST. No exemplo a seguir, você usará cURL para identificar o idioma em que um exemplo de texto foi escrito.

Pré-requisitos

Subscrição do Azure - Criar uma gratuitamente

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.

Use o link a seguir para criar um recurso de idioma usando o portal do Azure. Você precisará entrar usando sua assinatura do Azure.
Na tela Selecionar recursos adicionais exibida, selecione Continuar para criar seu recurso.

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.

Verifique se a caixa de seleção Aviso de IA Responsável está marcada.
Selecione Rever + Criar na parte inferior da página.
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.

Depois que o recurso de idioma for implantado com êxito, clique no botão Ir para recurso em Próximas etapas.
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.

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.

Para definir a LANGUAGE_KEY variável de ambiente, substitua your-key por uma das chaves do seu recurso.
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.

export LANGUAGE_KEY=your-key

export LANGUAGE_ENDPOINT=your-endpoint

Depois de adicionar as variáveis de ambiente, execute source ~/.bashrc a partir da janela do console para tornar as alterações efetivas.

Bash

export LANGUAGE_KEY=your-key

export LANGUAGE_ENDPOINT=your-endpoint

Depois de adicionar as variáveis de ambiente, execute source ~/.bash_profile a partir da janela do console para tornar as alterações efetivas.

XCode

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

Selecionar esquema de edição do esquema>de produtos>
Selecione Argumentos na página Executar (Depurar Executar)
Em Variáveis de Ambiente, selecione o sinal de mais (+) para adicionar uma nova variável de ambiente.
Digite LANGUAGE_KEY para o Nome e insira sua chave de recurso de idioma para o Valor.
Execute estas etapas para seu ponto de extremidade de recurso. Nomeie a nova variável LANGUAGE_ENDPOINTde ambiente .

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ódigos, crie um novo 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.

Nota

Você pode encontrar exemplos específicos de idiomas no GitHub.

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

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

Enviar um pedido de deteçã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	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_detection_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=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 pelo local do arquivo de 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 criadas para este 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

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 deteção de idioma

Guia de início rápido: usando a biblioteca de cliente de deteção de idioma 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

Configuração

Criar um recurso do Azure

Obtenha a sua chave e o seu ponto final

Criar variáveis de ambiente

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

Enviar um pedido de deteção de idioma

Linha de comandos

PowerShell

Resposta JSON

Clean up resources (Limpar recursos)

Próximos passos

Recursos adicionais