Snabbstart: använda klientbiblioteket för språkidentifiering och REST API

Artikel
04/11/2024

Referensdokumentation Fler exempelpaket | (NuGet) | Källkod för bibliotek |

Använd den här snabbstarten för att skapa ett språkidentifieringsprogram med klientbiblioteket för .NET. I följande exempel skapar du ett C#-program som kan identifiera språket som ett textexempel skrevs i.

Dricks

Du kan använda Language Studio för att prova språktjänstfunktioner utan att behöva skriva kod.

Förutsättningar

Azure-prenumeration – Skapa en kostnadsfritt
Visual Studio IDE
När du har din Azure-prenumeration skapar du en språkresurs i Azure-portalen för att hämta din nyckel och slutpunkt. När den har distribuerats väljer du Gå till resurs.
- Du behöver nyckeln och slutpunkten från resursen som du skapar för att ansluta ditt program till API:et. Du klistrar in nyckeln och slutpunkten i koden senare i snabbstarten.
- Du kan använda den kostnadsfria prisnivån (Free F0) för att prova tjänsten och uppgradera senare till en betald nivå för produktion.
Om du vill använda funktionen Analysera behöver du en språkresurs med standardprisnivån (S).

Konfigurera

Skapa en ny .NET Core-app

Skapa en ny .NET Core-konsolapp med Visual Studio IDE. Detta skapar ett "Hello World"-projekt med en enda C#-källfil: program.cs.

Installera klientbiblioteket genom att högerklicka på lösningen i Solution Explorer och välja Hantera NuGet-paket. I pakethanteraren som öppnas väljer du Bläddra och söker efter Azure.AI.TextAnalytics. Välj version 5.2.0 och sedan Installera. Du kan också använda Package Manager-konsolen.

Kodexempel

Kopiera följande kod till din program.cs-fil . Kom ihåg att ersätta variabeln key med nyckeln för resursen och ersätta variabeln endpoint med resursens slutpunkt. Kör sedan koden.

Viktigt!

Gå till Azure-portalen. Om språkresursen som du skapade i avsnittet Förutsättningar har distribuerats klickar du på knappen Gå till resurs under Nästa steg. Du hittar din nyckel och slutpunkt genom att gå till resursens sida Nycklar och slutpunkt under Resurshantering.

Viktigt!

Kom ihåg att ta bort nyckeln från koden när du är klar och publicera den aldrig offentligt. För produktion använder du ett säkert sätt att lagra och komma åt dina autentiseringsuppgifter som Azure Key Vault. Mer information finns i säkerhetsartikeln för Azure AI-tjänster.

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();
        }

    }
}

Output

Language:
    French, ISO-6391: fr

Referensdokumentation Fler exempelpaket | (Maven) | Källkod för bibliotek |

Använd den här snabbstarten för att skapa ett språkidentifieringsprogram med klientbiblioteket för Java. I följande exempel skapar du ett Java-program som kan identifiera språket som ett textexempel skrevs i.

Dricks

Du kan använda Language Studio för att prova språktjänstfunktioner utan att behöva skriva kod.

Förutsättningar

Azure-prenumeration – Skapa en kostnadsfritt
Java Development Kit (JDK) med version 8 eller senare
När du har din Azure-prenumeration skapar du en språkresurs i Azure-portalen för att hämta din nyckel och slutpunkt. När den har distribuerats väljer du Gå till resurs.
- Du behöver nyckeln och slutpunkten från resursen som du skapar för att ansluta ditt program till API:et. Du klistrar in din nyckel och slutpunkt i koden nedan senare i snabbstarten.
- Du kan använda den kostnadsfria prisnivån (Free F0) för att prova tjänsten och uppgradera senare till en betald nivå för produktion.
Om du vill använda funktionen Analysera behöver du en språkresurs med standardprisnivån (S).

Konfigurera

Lägga till klientbiblioteket

Skapa ett Maven-projekt i önskad IDE eller utvecklingsmiljö. Lägg sedan till följande beroende i projektets pom.xml-fil. Implementeringssyntaxen för andra byggverktyg finns online.

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

Kodexempel

Skapa en Java-fil som heter Example.java. Öppna filen och kopiera koden nedan. Kom ihåg att ersätta variabeln key med nyckeln för resursen och ersätta variabeln endpoint med resursens slutpunkt. Kör sedan koden.

Viktigt!

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());
    }
}

Output

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

Referensdokumentation Fler exempelpaket | (npm) | Källkod för bibliotek |

Använd den här snabbstarten för att skapa ett språkidentifieringsprogram med klientbiblioteket för Node.js. I följande exempel skapar du ett JavaScript-program som kan identifiera språket som ett textexempel skrevs i.

Dricks

Du kan använda Language Studio för att prova språktjänstfunktioner utan att behöva skriva kod.

Förutsättningar

Azure-prenumeration – Skapa en kostnadsfritt
Node.js v14 LTS eller senare
När du har din Azure-prenumeration skapar du en språkresurs i Azure-portalen för att hämta din nyckel och slutpunkt. När den har distribuerats väljer du Gå till resurs.
- Du behöver nyckeln och slutpunkten från resursen som du skapar för att ansluta ditt program till API:et. Du klistrar in din nyckel och slutpunkt i koden nedan senare i snabbstarten.
- Du kan använda den kostnadsfria prisnivån (Free F0) för att prova tjänsten och uppgradera senare till en betald nivå för produktion.
Om du vill använda funktionen Analysera behöver du en språkresurs med standardprisnivån (S).

Konfigurera

Skapa ett nytt Node.js-program

Skapa en ny katalog för din app i ett konsolfönster (till exempel cmd, PowerShell eller bash) och navigera till den.

mkdir myapp 

cd myapp

Kör kommandot npm init för att skapa ett nodprogram med en package.json-fil.

npm init

Installera klientbiblioteket

Installera npm-paketet:

npm install @azure/ai-language-text

Kodexempel

Öppna filen och kopiera koden nedan. Kom ihåg att ersätta variabeln key med nyckeln för resursen och ersätta variabeln endpoint med resursens slutpunkt. Kör sedan koden.

Viktigt!

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

Output

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

Referensdokumentation Fler exempelpaket | (PyPi) | Källkod för bibliotek |

Använd den här snabbstarten för att skapa ett språkidentifieringsprogram med klientbiblioteket för Python. I följande exempel skapar du ett Python-program som kan identifiera språket som ett textexempel skrevs i.

Dricks

Du kan använda Language Studio för att prova språktjänstfunktioner utan att behöva skriva kod.

Förutsättningar

Azure-prenumeration – Skapa en kostnadsfritt
Python 3.8 eller senare
När du har din Azure-prenumeration skapar du en språkresurs i Azure-portalen för att hämta din nyckel och slutpunkt. När den har distribuerats väljer du Gå till resurs.
- Du behöver nyckeln och slutpunkten från resursen som du skapar för att ansluta ditt program till API:et. Du klistrar in din nyckel och slutpunkt i koden nedan senare i snabbstarten.
- Du kan använda den kostnadsfria prisnivån (Free F0) för att prova tjänsten och uppgradera senare till en betald nivå för produktion.
Om du vill använda funktionen Analysera behöver du en språkresurs med standardprisnivån (S).

Konfigurera

Installera klientbiblioteket

När du har installerat Python kan du installera klientbiblioteket med:

pip install azure-ai-textanalytics==5.2.0

Kodexempel

Skapa en ny Python-fil och kopiera koden nedan. Kom ihåg att ersätta variabeln key med nyckeln för resursen och ersätta variabeln endpoint med resursens slutpunkt. Kör sedan koden.

Viktigt!


# 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)

Output

Language:  French

Referensdokumentation

Använd den här snabbstarten för att skicka begäranden om språkidentifiering med hjälp av REST-API:et. I följande exempel använder du cURL för att identifiera språket som ett textexempel skrevs i.

Förutsättningar

Azure-prenumeration – Skapa en kostnadsfritt

Konfigurera

Skapa en Azure-resurs

Om du vill använda kodexemplet nedan måste du distribuera en Azure-resurs. Den här resursen innehåller en nyckel och slutpunkt som du använder för att autentisera DE API-anrop som du skickar till språktjänsten.

Använd följande länk för att skapa en språkresurs med hjälp av Azure-portalen. Du måste logga in med din Azure-prenumeration.
På skärmen Välj ytterligare funktioner som visas väljer du Fortsätt för att skapa resursen.

På skärmen Skapa språk anger du följande information:

Information	beskrivning
Prenumeration	Det prenumerationskonto som resursen ska associeras med. Välj din Azure-prenumeration på den nedrullningsbara menyn.
Resursgrupp	En resursgrupp är en container som lagrar de resurser som du skapar. Välj Skapa ny för att skapa en ny resursgrupp.
Region	Platsen för språkresursen. Olika regioner kan ge svarstider beroende på din fysiska plats, men påverkar inte resursens körningstillgänglighet. För den här snabbstarten väljer du antingen en tillgänglig region nära dig eller usa , östra.
Name	Namnet på språkresursen. Det här namnet används också för att skapa en slutpunkts-URL som dina program använder för att skicka API-begäranden.
Prisnivå	Prisnivån för din språkresurs. Du kan använda den kostnadsfria F0-nivån för att prova tjänsten och uppgradera senare till en betald nivå för produktion.

Kontrollera att kryssrutan Ansvarig AI-meddelande är markerad.
Välj Granska + Skapa längst ned på sidan.
På skärmen som visas kontrollerar du att valideringen har passerat och att du har angett informationen korrekt. Välj sedan Skapa.

Hämta din nyckel och slutpunkt

Därefter behöver du nyckeln och slutpunkten från resursen för att ansluta ditt program till API:et. Du klistrar in nyckeln och slutpunkten i koden senare i snabbstarten.

När språkresursen har distribuerats klickar du på knappen Gå till resurs under Nästa steg.
På skärmen för resursen väljer du Nycklar och slutpunkt på den vänstra navigeringsmenyn. Du använder en av dina nycklar och slutpunkten i stegen nedan.

Skapa miljövariabler

Ditt program måste autentiseras för att skicka API-begäranden. För produktion använder du ett säkert sätt att lagra och komma åt dina autentiseringsuppgifter. I det här exemplet skriver du dina autentiseringsuppgifter till miljövariabler på den lokala dator som kör programmet.

Dricks

Inkludera inte nyckeln direkt i koden och publicera den aldrig offentligt. Mer autentiseringsalternativ som Azure Key Vault finns i säkerhetsartikeln för Azure AI-tjänster.

Om du vill ange miljövariabeln för din språkresursnyckel öppnar du ett konsolfönster och följer anvisningarna för operativsystemet och utvecklingsmiljön.

Om du vill ange LANGUAGE_KEY miljövariabeln ersätter du your-key med en av nycklarna för resursen.
Om du vill ange LANGUAGE_ENDPOINT miljövariabeln ersätter du your-endpoint med slutpunkten för resursen.

setx LANGUAGE_KEY your-key

setx LANGUAGE_ENDPOINT your-endpoint

Kommentar

Om du bara behöver komma åt miljövariablerna i den aktuella konsolen som körs kan du ange miljövariabeln med set i stället för setx.

När du har lagt till miljövariablerna kan du behöva starta om alla program som körs och som behöver läsa miljövariablerna, inklusive konsolfönstret. Om du till exempel använder Visual Studio som redigerare startar du om Visual Studio innan du kör exemplet.

export LANGUAGE_KEY=your-key

export LANGUAGE_ENDPOINT=your-endpoint

När du har lagt till miljövariablerna kör source ~/.bashrc du från konsolfönstret för att göra ändringarna effektiva.

Bash

export LANGUAGE_KEY=your-key

export LANGUAGE_ENDPOINT=your-endpoint

När du har lagt till miljövariablerna kör source ~/.bash_profile du från konsolfönstret för att göra ändringarna effektiva.

Xcode

För iOS- och macOS-utveckling anger du miljövariablerna i Xcode. Följ till exempel de här stegen för att ange miljövariabeln i Xcode 13.4.1.

Välj Redigeringsschema för produktschema>>
Välj argument på sidan Kör (felsökningskörning)
Under Miljövariabler väljer du plustecknet (+) för att lägga till en ny miljövariabel.
Ange LANGUAGE_KEY som Namn och ange resursnyckeln Språk för Värdet.
Utför de här stegen för resursslutpunkten. Ge den nya miljövariabeln LANGUAGE_ENDPOINTnamnet .

Fler konfigurationsalternativ finns i Xcode-dokumentationen.

Skapa en JSON-fil med exempelbegärandetexten

I en kodredigerare skapar du en ny fil med namnet test_detection_payload.json och kopierar följande JSON-exempel. Den här exempelbegäran skickas till API:et i nästa steg.

Kommentar

Du hittar språkspecifika exempel på GitHub.

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

Spara test_detection_payload.json någonstans på datorn. Till exempel skrivbordet.

Skicka en begäran om språkidentifiering

Använd följande kommandon för att skicka API-begäran med det program du använder. Kopiera kommandot till terminalen och kör det.

parameter	Description
`-X POST <endpoint>`	Anger slutpunkten för åtkomst till API:et.
`-H Content-Type: application/json`	Innehållstypen för att skicka JSON-data.
`-H "Ocp-Apim-Subscription-Key:<key>`	Anger nyckeln för åtkomst till API:et.
`-d <documents>`	JSON som innehåller de dokument som du vill skicka.

Ersätt C:\Users\<myaccount>\Desktop\test_detection_payload.json med platsen för JSON-exempelbegärandefilen som du skapade i föregående steg.

Kommandotolk

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"

Använd följande kommandon för att skicka API-begäran med det program du använder. Ersätt /home/mydir/test_detection_payload.json med platsen för JSON-exempelbegärandefilen som du skapade i föregående steg.

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"

JSON-svar

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

Använd följande kommandon för att ta bort miljövariablerna som du skapade för den här snabbstarten.

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

Rensa resurser

Om du vill rensa och ta bort en Azure AI-tjänstprenumeration kan du ta bort resursen eller resursgruppen. Om du tar bort resursgruppen tas även alla andra resurser som är associerade med den bort.

Nästa steg

Översikt över språkidentifiering

Dela via

Snabbstart: använda klientbiblioteket för språkidentifiering och REST API

Förutsättningar

Konfigurera

Skapa en ny .NET Core-app

Kodexempel

Output

Förutsättningar

Konfigurera

Lägga till klientbiblioteket

Kodexempel

Output

Förutsättningar

Konfigurera

Skapa ett nytt Node.js-program

Installera klientbiblioteket

Kodexempel

Output

Förutsättningar

Konfigurera

Installera klientbiblioteket

Kodexempel

Output

Förutsättningar

Konfigurera

Skapa en Azure-resurs

Hämta din nyckel och slutpunkt

Skapa miljövariabler

Bash

Xcode

Skapa en JSON-fil med exempelbegärandetexten

Skicka en begäran om språkidentifiering

Kommandotolk

PowerShell

JSON-svar

Rensa resurser

Nästa steg

Ytterligare resurser