Inicio rápido: Vinculación de entidad mediante la biblioteca cliente y la API REST

  • Artículo

Documentación de referencia | Más ejemplos | Paquete (NuGet) | Código fuente de biblioteca

Use este inicio rápido para crear una aplicación de vinculación de entidad con la biblioteca cliente de .NET. En el ejemplo siguiente, creará una aplicación de C# que puede identificar y eliminar la ambigüedad de las entidades que se encuentran en el texto.

Sugerencia

Puede usar Language Studio para probar las características del servicio de lenguaje sin necesidad de escribir código.

Requisitos previos

Instalación

Creación de un recurso de Azure

Para usar el siguiente código de ejemplo, tendrá que implementar un recurso de Azure. Este recurso contendrá una clave y un punto de conexión que se usarán para autenticar las llamadas API que envíe al servicio de lenguaje.

  1. Use el vínculo siguiente para crear un recurso de lenguaje mediante Azure Portal. Tendrá que iniciar sesión con su suscripción de Azure.

  2. En la pantalla Seleccionar características adicionales, seleccione Continuar para crear el recurso.

    Captura de pantalla que muestra opciones de características adicionales en Azure Portal.

  3. En la pantalla Crear lenguaje, proporcione la siguiente información:

    Detalle Descripción
    Suscripción La cuenta de suscripción a la que se asociará el recurso. Seleccione la suscripción de Azure en el menú desplegable.
    Resource group Un grupo de recursos es un contenedor que almacena los recursos que crea. Seleccione Crear nuevo para crear un nuevo grupo de recursos.
    Region La ubicación del recurso de idioma. Las diferentes regiones pueden crear latencias, según la ubicación física en la que usted se encuentre, pero no tienen ningún impacto en la disponibilidad del tiempo de ejecución del recurso. En este inicio rápido, seleccione una región disponible cerca de usted o elija Este de EE. UU.
    Nombre Nombre para el recurso de lenguaje. Este nombre también se usará para crear una dirección URL de punto de conexión que las aplicaciones usarán para enviar solicitudes de API.
    Plan de tarifa Plan de tarifa del recurso de idioma. Puede usar el nivel Gratis F0 para probar el servicio y actualizarlo más adelante a un nivel de pago cuando pase a producción.

    Captura de pantalla que muestra en detalle la creación de un recurso en Azure Portal.

  4. Asegúrese de que la casilla Aviso de IA responsable esté activada.

  5. En la parte inferior de la página, seleccione Revisar y crear.

  6. En la pantalla que aparece, asegúrese de que se ha superado la validación y de que ha escrito la información correctamente. Seleccione Crear.

Obtención de la clave y el punto de conexión

Ahora necesitará la clave y el punto de conexión del recurso para conectar la aplicación a la API. En una sección posterior de este mismo inicio rápido, pegará la clave y el punto de conexión en el código.

  1. Después de que el recurso de lenguaje se implemente correctamente, haga clic en el botón Ir al recurso en Pasos siguientes.

    Captura de pantalla que muestra los pasos siguientes después de implementar un recurso.

  2. En la pantalla del recurso, seleccione Claves y punto de conexión en el menú de navegación izquierdo. Usará una de las claves y el punto de conexión en los pasos siguientes.

    Captura de pantalla en la que se muestra la sección de claves y punto de conexión de un recurso.

Creación de variables de entorno

La aplicación debe autenticarse para enviar solicitudes de API. En el caso de producción, use una forma segura de almacenar sus credenciales y acceder a ellas. En este ejemplo, escribirá las credenciales en variables de entorno del equipo local que ejecuta la aplicación.

Sugerencia

No incluya la clave directamente en el código ni la exponga nunca públicamente. Consulte el artículo de Seguridad de los servicios de Azure AI para ver más opciones de autenticación, como Azure Key Vault.

Para establecer la variable de entorno para la clave del recurso de lenguaje, abra una ventana de consola y siga las instrucciones correspondientes a su sistema operativo y su entorno de desarrollo.

  1. Para establecer la variable de entorno LANGUAGE_KEY, reemplace your-key por una de las claves del recurso.
  2. Para establecer la variable de entorno LANGUAGE_ENDPOINT, reemplace your-endpoint por el punto de conexión del recurso.
setx LANGUAGE_KEY your-key

setx LANGUAGE_ENDPOINT your-endpoint

Nota:

Si solo necesita acceder a las variables de entorno en la consola que se está ejecutando en este momento, puede establecer la variable de entorno con set en vez de con setx.

Después de agregar las variables de entorno, puede que tenga que reiniciar todos los programas en ejecución que necesiten leer la variable de entorno, incluida la ventana de consola. Por ejemplo, si usa Visual Studio como editor, reinícielo antes de ejecutar el ejemplo.

Creación de una aplicación de .NET Core

Utilice el IDE de Visual Studio para crear una aplicación de consola de .NET Core. Así se creará un proyecto "Hola mundo" con un solo archivo de origen de C#: program.cs.

Instale la biblioteca cliente, para lo que debe hacer clic con el botón derecho en la solución en el Explorador de soluciones y seleccionar Administrar paquetes NuGet. En el administrador de paquetes que se abre, seleccione Examinar y busque Azure.AI.TextAnalytics. Seleccione la versión 5.2.0 e Instalar. También puede usar la Consola del Administrador de paquetes.

Ejemplo de código

Copie el código siguiente en el archivo program.cs y ejecute el código.

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

namespace EntityLinkingExample
{
    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 recognizing entities and providing a link to an online data source.
        static void EntityLinkingExample(TextAnalyticsClient client)
        {
            var response = client.RecognizeLinkedEntities(
                "Microsoft was founded by Bill Gates and Paul Allen on April 4, 1975, " +
                "to develop and sell BASIC interpreters for the Altair 8800. " +
                "During his career at Microsoft, Gates held the positions of chairman, " +
                "chief executive officer, president and chief software architect, " +
                "while also being the largest individual shareholder until May 2014.");
            Console.WriteLine("Linked Entities:");
            foreach (var entity in response.Value)
            {
                Console.WriteLine($"\tName: {entity.Name},\tID: {entity.DataSourceEntityId},\tURL: {entity.Url}\tData Source: {entity.DataSource}");
                Console.WriteLine("\tMatches:");
                foreach (var match in entity.Matches)
                {
                    Console.WriteLine($"\t\tText: {match.Text}");
                    Console.WriteLine($"\t\tScore: {match.ConfidenceScore:F2}\n");
                }
            }
        }

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

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

    }
}

Output

Linked Entities:
    Name: Microsoft,        ID: Microsoft,  URL: https://en.wikipedia.org/wiki/Microsoft    Data Source: Wikipedia
    Matches:
            Text: Microsoft
            Score: 0.55

            Text: Microsoft
            Score: 0.55

    Name: Bill Gates,       ID: Bill Gates, URL: https://en.wikipedia.org/wiki/Bill_Gates   Data Source: Wikipedia
    Matches:
            Text: Bill Gates
            Score: 0.63

            Text: Gates
            Score: 0.63

    Name: Paul Allen,       ID: Paul Allen, URL: https://en.wikipedia.org/wiki/Paul_Allen   Data Source: Wikipedia
    Matches:
            Text: Paul Allen
            Score: 0.60

    Name: April 4,  ID: April 4,    URL: https://en.wikipedia.org/wiki/April_4      Data Source: Wikipedia
    Matches:
            Text: April 4
            Score: 0.32

    Name: BASIC,    ID: BASIC,      URL: https://en.wikipedia.org/wiki/BASIC        Data Source: Wikipedia
    Matches:
            Text: BASIC
            Score: 0.33

    Name: Altair 8800,      ID: Altair 8800,        URL: https://en.wikipedia.org/wiki/Altair_8800  Data Source: Wikipedia
    Matches:
            Text: Altair 8800
            Score: 0.88

Limpieza de recursos

Si quiere limpiar y eliminar una suscripción de servicios de Azure AI, puede eliminar el recurso o el grupo de recursos. Al eliminar el grupo de recursos, también se elimina cualquier otro recurso que esté asociado a él.

Pasos siguientes

Documentación de referencia | Más ejemplos | Paquete (Maven) | Código fuente de biblioteca

Use este inicio rápido para crear una aplicación de vinculación de entidad con la biblioteca cliente de Java. En el ejemplo siguiente, se crea una aplicación Java que puede identificar y eliminar la ambigüedad de las entidades que se encuentran en el texto.

Requisitos previos

Instalación

Creación de un recurso de Azure

Para usar el siguiente código de ejemplo, tendrá que implementar un recurso de Azure. Este recurso contendrá una clave y un punto de conexión que se usarán para autenticar las llamadas API que envíe al servicio de lenguaje.

  1. Use el vínculo siguiente para crear un recurso de lenguaje mediante Azure Portal. Tendrá que iniciar sesión con su suscripción de Azure.

  2. En la pantalla Seleccionar características adicionales, seleccione Continuar para crear el recurso.

    Captura de pantalla que muestra opciones de características adicionales en Azure Portal.

  3. En la pantalla Crear lenguaje, proporcione la siguiente información:

    Detalle Descripción
    Suscripción La cuenta de suscripción a la que se asociará el recurso. Seleccione la suscripción de Azure en el menú desplegable.
    Resource group Un grupo de recursos es un contenedor que almacena los recursos que crea. Seleccione Crear nuevo para crear un nuevo grupo de recursos.
    Region La ubicación del recurso de idioma. Las diferentes regiones pueden crear latencias, según la ubicación física en la que usted se encuentre, pero no tienen ningún impacto en la disponibilidad del tiempo de ejecución del recurso. En este inicio rápido, seleccione una región disponible cerca de usted o elija Este de EE. UU.
    Nombre Nombre para el recurso de lenguaje. Este nombre también se usará para crear una dirección URL de punto de conexión que las aplicaciones usarán para enviar solicitudes de API.
    Plan de tarifa Plan de tarifa del recurso de idioma. Puede usar el nivel Gratis F0 para probar el servicio y actualizarlo más adelante a un nivel de pago cuando pase a producción.

    Captura de pantalla que muestra en detalle la creación de un recurso en Azure Portal.

  4. Asegúrese de que la casilla Aviso de IA responsable esté activada.

  5. En la parte inferior de la página, seleccione Revisar y crear.

  6. En la pantalla que aparece, asegúrese de que se ha superado la validación y de que ha escrito la información correctamente. Seleccione Crear.

Obtención de la clave y el punto de conexión

Ahora necesitará la clave y el punto de conexión del recurso para conectar la aplicación a la API. En una sección posterior de este mismo inicio rápido, pegará la clave y el punto de conexión en el código.

  1. Después de que el recurso de lenguaje se implemente correctamente, haga clic en el botón Ir al recurso en Pasos siguientes.

    Captura de pantalla que muestra los pasos siguientes después de implementar un recurso.

  2. En la pantalla del recurso, seleccione Claves y punto de conexión en el menú de navegación izquierdo. Usará una de las claves y el punto de conexión en los pasos siguientes.

    Captura de pantalla en la que se muestra la sección de claves y punto de conexión de un recurso.

Creación de variables de entorno

La aplicación debe autenticarse para enviar solicitudes de API. En el caso de producción, use una forma segura de almacenar sus credenciales y acceder a ellas. En este ejemplo, escribirá las credenciales en variables de entorno del equipo local que ejecuta la aplicación.

Sugerencia

No incluya la clave directamente en el código ni la exponga nunca públicamente. Consulte el artículo de Seguridad de los servicios de Azure AI para ver más opciones de autenticación, como Azure Key Vault.

Para establecer la variable de entorno para la clave del recurso de lenguaje, abra una ventana de consola y siga las instrucciones correspondientes a su sistema operativo y su entorno de desarrollo.

  1. Para establecer la variable de entorno LANGUAGE_KEY, reemplace your-key por una de las claves del recurso.
  2. Para establecer la variable de entorno LANGUAGE_ENDPOINT, reemplace your-endpoint por el punto de conexión del recurso.
setx LANGUAGE_KEY your-key

setx LANGUAGE_ENDPOINT your-endpoint

Nota:

Si solo necesita acceder a las variables de entorno en la consola que se está ejecutando en este momento, puede establecer la variable de entorno con set en vez de con setx.

Después de agregar las variables de entorno, puede que tenga que reiniciar todos los programas en ejecución que necesiten leer la variable de entorno, incluida la ventana de consola. Por ejemplo, si usa Visual Studio como editor, reinícielo antes de ejecutar el ejemplo.

Incorporación de la biblioteca cliente

Cree un proyecto de Maven en el entorno de desarrollo o IDE que prefiera. Luego, agregue la siguiente dependencia al archivo pom.xml del proyecto. La sintaxis de implementación de otras herramientas de compilación se puede encontrar en línea.

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

Ejemplo de código

Cree un archivo de Java llamado Example.java. Abra el archivo y copie el código siguiente. Luego, ejecute el 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);
        recognizeLinkedEntitiesExample(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 and providing a link to an online data source
    static void recognizeLinkedEntitiesExample(TextAnalyticsClient client)
    {
        // The text that need be analyzed.
        String text = "Microsoft was founded by Bill Gates and Paul Allen on April 4, 1975, " +
                "to develop and sell BASIC interpreters for the Altair 8800. " +
                "During his career at Microsoft, Gates held the positions of chairman, " +
                "chief executive officer, president and chief software architect, " +
                "while also being the largest individual shareholder until May 2014.";

        System.out.printf("Linked Entities:%n");
        for (LinkedEntity linkedEntity : client.recognizeLinkedEntities(text)) {
            System.out.printf("Name: %s, ID: %s, URL: %s, Data Source: %s.%n",
                    linkedEntity.getName(),
                    linkedEntity.getDataSourceEntityId(),
                    linkedEntity.getUrl(),
                    linkedEntity.getDataSource());
            System.out.printf("Matches:%n");
            for (LinkedEntityMatch linkedEntityMatch : linkedEntity.getMatches()) {
                System.out.printf("Text: %s, Score: %.2f, Offset: %s, Length: %s%n",
                        linkedEntityMatch.getText(),
                        linkedEntityMatch.getConfidenceScore(),
                        linkedEntityMatch.getOffset(),
                        linkedEntityMatch.getLength());
            }
        }
    }
}

Resultados

Linked Entities:

Name: Microsoft, ID: Microsoft, URL: https://en.wikipedia.org/wiki/Microsoft, Data Source: Wikipedia.
Matches:
Text: Microsoft, Score: 0.55, Offset: 0, Length: 9
Text: Microsoft, Score: 0.55, Offset: 150, Length: 9
Name: Bill Gates, ID: Bill Gates, URL: https://en.wikipedia.org/wiki/Bill_Gates, Data Source: Wikipedia.
Matches:
Text: Bill Gates, Score: 0.63, Offset: 25, Length: 10
Text: Gates, Score: 0.63, Offset: 161, Length: 5
Name: Paul Allen, ID: Paul Allen, URL: https://en.wikipedia.org/wiki/Paul_Allen, Data Source: Wikipedia.
Matches:
Text: Paul Allen, Score: 0.60, Offset: 40, Length: 10
Name: April 4, ID: April 4, URL: https://en.wikipedia.org/wiki/April_4, Data Source: Wikipedia.
Matches:
Text: April 4, Score: 0.32, Offset: 54, Length: 7
Name: BASIC, ID: BASIC, URL: https://en.wikipedia.org/wiki/BASIC, Data Source: Wikipedia.
Matches:
Text: BASIC, Score: 0.33, Offset: 89, Length: 5
Name: Altair 8800, ID: Altair 8800, URL: https://en.wikipedia.org/wiki/Altair_8800, Data Source: Wikipedia.
Matches:
Text: Altair 8800, Score: 0.88, Offset: 116, Length: 11

Limpieza de recursos

Si quiere limpiar y eliminar una suscripción de servicios de Azure AI, puede eliminar el recurso o el grupo de recursos. Al eliminar el grupo de recursos, también se elimina cualquier otro recurso que esté asociado a él.

Pasos siguientes

Documentación de referencia | Más ejemplos | Paquete (npm) | Código fuente de biblioteca

Use este inicio rápido para crear una aplicación de vinculación de entidad con la biblioteca cliente de Node.js. En el ejemplo siguiente, creará una aplicación de JavaScript que puede identificar y eliminar la ambigüedad de las entidades que se encuentran en el texto.

Requisitos previos

Instalación

Creación de un recurso de Azure

Para usar el siguiente código de ejemplo, tendrá que implementar un recurso de Azure. Este recurso contendrá una clave y un punto de conexión que se usarán para autenticar las llamadas API que envíe al servicio de lenguaje.

  1. Use el vínculo siguiente para crear un recurso de lenguaje mediante Azure Portal. Tendrá que iniciar sesión con su suscripción de Azure.

  2. En la pantalla Seleccionar características adicionales, seleccione Continuar para crear el recurso.

    Captura de pantalla que muestra opciones de características adicionales en Azure Portal.

  3. En la pantalla Crear lenguaje, proporcione la siguiente información:

    Detalle Descripción
    Suscripción La cuenta de suscripción a la que se asociará el recurso. Seleccione la suscripción de Azure en el menú desplegable.
    Resource group Un grupo de recursos es un contenedor que almacena los recursos que crea. Seleccione Crear nuevo para crear un nuevo grupo de recursos.
    Region La ubicación del recurso de idioma. Las diferentes regiones pueden crear latencias, según la ubicación física en la que usted se encuentre, pero no tienen ningún impacto en la disponibilidad del tiempo de ejecución del recurso. En este inicio rápido, seleccione una región disponible cerca de usted o elija Este de EE. UU.
    Nombre Nombre para el recurso de lenguaje. Este nombre también se usará para crear una dirección URL de punto de conexión que las aplicaciones usarán para enviar solicitudes de API.
    Plan de tarifa Plan de tarifa del recurso de idioma. Puede usar el nivel Gratis F0 para probar el servicio y actualizarlo más adelante a un nivel de pago cuando pase a producción.

    Captura de pantalla que muestra en detalle la creación de un recurso en Azure Portal.

  4. Asegúrese de que la casilla Aviso de IA responsable esté activada.

  5. En la parte inferior de la página, seleccione Revisar y crear.

  6. En la pantalla que aparece, asegúrese de que se ha superado la validación y de que ha escrito la información correctamente. Seleccione Crear.

Obtención de la clave y el punto de conexión

Ahora necesitará la clave y el punto de conexión del recurso para conectar la aplicación a la API. En una sección posterior de este mismo inicio rápido, pegará la clave y el punto de conexión en el código.

  1. Después de que el recurso de lenguaje se implemente correctamente, haga clic en el botón Ir al recurso en Pasos siguientes.

    Captura de pantalla que muestra los pasos siguientes después de implementar un recurso.

  2. En la pantalla del recurso, seleccione Claves y punto de conexión en el menú de navegación izquierdo. Usará una de las claves y el punto de conexión en los pasos siguientes.

    Captura de pantalla en la que se muestra la sección de claves y punto de conexión de un recurso.

Creación de variables de entorno

La aplicación debe autenticarse para enviar solicitudes de API. En el caso de producción, use una forma segura de almacenar sus credenciales y acceder a ellas. En este ejemplo, escribirá las credenciales en variables de entorno del equipo local que ejecuta la aplicación.

Sugerencia

No incluya la clave directamente en el código ni la exponga nunca públicamente. Consulte el artículo de Seguridad de los servicios de Azure AI para ver más opciones de autenticación, como Azure Key Vault.

Para establecer la variable de entorno para la clave del recurso de lenguaje, abra una ventana de consola y siga las instrucciones correspondientes a su sistema operativo y su entorno de desarrollo.

  1. Para establecer la variable de entorno LANGUAGE_KEY, reemplace your-key por una de las claves del recurso.
  2. Para establecer la variable de entorno LANGUAGE_ENDPOINT, reemplace your-endpoint por el punto de conexión del recurso.
setx LANGUAGE_KEY your-key

setx LANGUAGE_ENDPOINT your-endpoint

Nota:

Si solo necesita acceder a las variables de entorno en la consola que se está ejecutando en este momento, puede establecer la variable de entorno con set en vez de con setx.

Después de agregar las variables de entorno, puede que tenga que reiniciar todos los programas en ejecución que necesiten leer la variable de entorno, incluida la ventana de consola. Por ejemplo, si usa Visual Studio como editor, reinícielo antes de ejecutar el ejemplo.

Creación de una aplicación Node.js

En una ventana de la consola (como cmd, PowerShell o Bash), cree un directorio para la aplicación y vaya a él.

mkdir myapp 

cd myapp

Ejecute el comando npm init para crear una aplicación de nodo con un archivo package.json.

npm init

Instalación de la biblioteca cliente

Instale el paquete npm:

npm install @azure/ai-language-text

Ejemplo de código

Abra el archivo y copie el código siguiente. Luego, ejecute el 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;

//example sentence for recognizing entities
const documents = ["Microsoft was founded by Bill Gates and Paul Allen on April 4, 1975."];

//example of how to use the client to perform entity linking on a document
async function main() {
    console.log("== Entity linking sample ==");
  
    const client = new TextAnalysisClient(endpoint, new AzureKeyCredential(key));
  
    const results = await client.analyze("EntityLinking", documents);
  
    for (const result of results) {
      console.log(`- Document ${result.id}`);
      if (!result.error) {
        console.log("\tEntities:");
        for (const entity of result.entities) {
          console.log(
            `\t- Entity ${entity.name}; link ${entity.url}; datasource: ${entity.dataSource}`
          );
          console.log("\t\tMatches:");
          for (const match of entity.matches) {
            console.log(
              `\t\t- Entity appears as "${match.text}" (confidence: ${match.confidenceScore}`
            );
          }
        }
      } else {
        console.error("  Error:", result.error);
      }
    }
  }

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

Resultados

== Entity linking sample ==
- Document 0
    Entities:
    - Entity Microsoft; link https://en.wikipedia.org/wiki/Microsoft; datasource: Wikipedia
            Matches:
            - Entity appears as "Microsoft" (confidence: 0.48
    - Entity Bill Gates; link https://en.wikipedia.org/wiki/Bill_Gates; datasource: Wikipedia
            Matches:
            - Entity appears as "Bill Gates" (confidence: 0.52
    - Entity Paul Allen; link https://en.wikipedia.org/wiki/Paul_Allen; datasource: Wikipedia
            Matches:
            - Entity appears as "Paul Allen" (confidence: 0.54
    - Entity April 4; link https://en.wikipedia.org/wiki/April_4; datasource: Wikipedia
            Matches:
            - Entity appears as "April 4" (confidence: 0.38

Limpieza de recursos

Si quiere limpiar y eliminar una suscripción de servicios de Azure AI, puede eliminar el recurso o el grupo de recursos. Al eliminar el grupo de recursos, también se elimina cualquier otro recurso que esté asociado a él.

Pasos siguientes

Documentación de referencia | Más ejemplos | Paquete (PyPi) | Código fuente de biblioteca

Use este inicio rápido para crear una aplicación de vinculación de entidad con la biblioteca cliente de Python. En el ejemplo siguiente, se crea una aplicación de Python que puede identificar y eliminar la ambigüedad de las entidades que se encuentran en el texto.

Requisitos previos

Instalación

Creación de un recurso de Azure

Para usar el siguiente código de ejemplo, tendrá que implementar un recurso de Azure. Este recurso contendrá una clave y un punto de conexión que se usarán para autenticar las llamadas API que envíe al servicio de lenguaje.

  1. Use el vínculo siguiente para crear un recurso de lenguaje mediante Azure Portal. Tendrá que iniciar sesión con su suscripción de Azure.

  2. En la pantalla Seleccionar características adicionales, seleccione Continuar para crear el recurso.

    Captura de pantalla que muestra opciones de características adicionales en Azure Portal.

  3. En la pantalla Crear lenguaje, proporcione la siguiente información:

    Detalle Descripción
    Suscripción La cuenta de suscripción a la que se asociará el recurso. Seleccione la suscripción de Azure en el menú desplegable.
    Resource group Un grupo de recursos es un contenedor que almacena los recursos que crea. Seleccione Crear nuevo para crear un nuevo grupo de recursos.
    Region La ubicación del recurso de idioma. Las diferentes regiones pueden crear latencias, según la ubicación física en la que usted se encuentre, pero no tienen ningún impacto en la disponibilidad del tiempo de ejecución del recurso. En este inicio rápido, seleccione una región disponible cerca de usted o elija Este de EE. UU.
    Nombre Nombre para el recurso de lenguaje. Este nombre también se usará para crear una dirección URL de punto de conexión que las aplicaciones usarán para enviar solicitudes de API.
    Plan de tarifa Plan de tarifa del recurso de idioma. Puede usar el nivel Gratis F0 para probar el servicio y actualizarlo más adelante a un nivel de pago cuando pase a producción.

    Captura de pantalla que muestra en detalle la creación de un recurso en Azure Portal.

  4. Asegúrese de que la casilla Aviso de IA responsable esté activada.

  5. En la parte inferior de la página, seleccione Revisar y crear.

  6. En la pantalla que aparece, asegúrese de que se ha superado la validación y de que ha escrito la información correctamente. Seleccione Crear.

Obtención de la clave y el punto de conexión

Ahora necesitará la clave y el punto de conexión del recurso para conectar la aplicación a la API. En una sección posterior de este mismo inicio rápido, pegará la clave y el punto de conexión en el código.

  1. Después de que el recurso de lenguaje se implemente correctamente, haga clic en el botón Ir al recurso en Pasos siguientes.

    Captura de pantalla que muestra los pasos siguientes después de implementar un recurso.

  2. En la pantalla del recurso, seleccione Claves y punto de conexión en el menú de navegación izquierdo. Usará una de las claves y el punto de conexión en los pasos siguientes.

    Captura de pantalla en la que se muestra la sección de claves y punto de conexión de un recurso.

Creación de variables de entorno

La aplicación debe autenticarse para enviar solicitudes de API. En el caso de producción, use una forma segura de almacenar sus credenciales y acceder a ellas. En este ejemplo, escribirá las credenciales en variables de entorno del equipo local que ejecuta la aplicación.

Sugerencia

No incluya la clave directamente en el código ni la exponga nunca públicamente. Consulte el artículo de Seguridad de los servicios de Azure AI para ver más opciones de autenticación, como Azure Key Vault.

Para establecer la variable de entorno para la clave del recurso de lenguaje, abra una ventana de consola y siga las instrucciones correspondientes a su sistema operativo y su entorno de desarrollo.

  1. Para establecer la variable de entorno LANGUAGE_KEY, reemplace your-key por una de las claves del recurso.
  2. Para establecer la variable de entorno LANGUAGE_ENDPOINT, reemplace your-endpoint por el punto de conexión del recurso.
setx LANGUAGE_KEY your-key

setx LANGUAGE_ENDPOINT your-endpoint

Nota:

Si solo necesita acceder a las variables de entorno en la consola que se está ejecutando en este momento, puede establecer la variable de entorno con set en vez de con setx.

Después de agregar las variables de entorno, puede que tenga que reiniciar todos los programas en ejecución que necesiten leer la variable de entorno, incluida la ventana de consola. Por ejemplo, si usa Visual Studio como editor, reinícielo antes de ejecutar el ejemplo.

Instalación de la biblioteca cliente

Después de instalar Python, puede instalar la biblioteca cliente con:

pip install azure-ai-textanalytics==5.2.0

Ejemplo de código

Cree un nuevo archivo de Python y copie el código siguiente. Luego, ejecute el 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 and providing a link to an online data source.
def entity_linking_example(client):

    try:
        documents = ["""Microsoft was founded by Bill Gates and Paul Allen on April 4, 1975, 
        to develop and sell BASIC interpreters for the Altair 8800. 
        During his career at Microsoft, Gates held the positions of chairman,
        chief executive officer, president and chief software architect, 
        while also being the largest individual shareholder until May 2014."""]
        result = client.recognize_linked_entities(documents = documents)[0]

        print("Linked Entities:\n")
        for entity in result.entities:
            print("\tName: ", entity.name, "\tId: ", entity.data_source_entity_id, "\tUrl: ", entity.url,
            "\n\tData Source: ", entity.data_source)
            print("\tMatches:")
            for match in entity.matches:
                print("\t\tText:", match.text)
                print("\t\tConfidence Score: {0:.2f}".format(match.confidence_score))
                print("\t\tOffset: {}".format(match.offset))
                print("\t\tLength: {}".format(match.length))
            
    except Exception as err:
        print("Encountered exception. {}".format(err))
entity_linking_example(client)

Resultados

Linked Entities:
    
    Name:  Microsoft        Id:  Microsoft  Url:  https://en.wikipedia.org/wiki/Microsoft
    Data Source:  Wikipedia
    Matches:
            Text: Microsoft
            Confidence Score: 0.55
            Offset: 0
            Length: 9
            Text: Microsoft
            Confidence Score: 0.55
            Offset: 168
            Length: 9
    Name:  Bill Gates       Id:  Bill Gates         Url:  https://en.wikipedia.org/wiki/Bill_Gates
    Data Source:  Wikipedia
    Matches:
            Text: Bill Gates
            Confidence Score: 0.63
            Offset: 25
            Length: 10
            Text: Gates
            Confidence Score: 0.63
            Offset: 179
            Length: 5
    Name:  Paul Allen       Id:  Paul Allen         Url:  https://en.wikipedia.org/wiki/Paul_Allen
    Data Source:  Wikipedia
    Matches:
            Text: Paul Allen
            Confidence Score: 0.60
            Offset: 40
            Length: 10
    Name:  April 4  Id:  April 4    Url:  https://en.wikipedia.org/wiki/April_4
    Data Source:  Wikipedia
    Matches:
            Text: BASIC
            Confidence Score: 0.33
            Offset: 98
            Length: 5
    Name:  Altair 8800      Id:  Altair 8800        Url:  https://en.wikipedia.org/wiki/Altair_8800
    Data Source:  Wikipedia
    Matches:
            Text: Altair 8800
            Confidence Score: 0.88
            Offset: 125
            Length: 11

Limpieza de recursos

Si quiere limpiar y eliminar una suscripción de servicios de Azure AI, puede eliminar el recurso o el grupo de recursos. Al eliminar el grupo de recursos, también se elimina cualquier otro recurso que esté asociado a él.

Pasos siguientes

Documentación de referencia

Use este inicio rápido para enviar solicitudes de vinculación de entidad mediante la API REST. En el ejemplo siguiente, usará cURL para identificar y eliminar la ambigüedad de las entidades que se encuentran en el texto.

Requisitos previos

Instalación

Creación de un recurso de Azure

Para usar el siguiente código de ejemplo, tendrá que implementar un recurso de Azure. Este recurso contendrá una clave y un punto de conexión que se usarán para autenticar las llamadas API que envíe al servicio de lenguaje.

  1. Use el vínculo siguiente para crear un recurso de lenguaje mediante Azure Portal. Tendrá que iniciar sesión con su suscripción de Azure.

  2. En la pantalla Seleccionar características adicionales, seleccione Continuar para crear el recurso.

    Captura de pantalla que muestra opciones de características adicionales en Azure Portal.

  3. En la pantalla Crear lenguaje, proporcione la siguiente información:

    Detalle Descripción
    Suscripción La cuenta de suscripción a la que se asociará el recurso. Seleccione la suscripción de Azure en el menú desplegable.
    Resource group Un grupo de recursos es un contenedor que almacena los recursos que crea. Seleccione Crear nuevo para crear un nuevo grupo de recursos.
    Region La ubicación del recurso de idioma. Las diferentes regiones pueden crear latencias, según la ubicación física en la que usted se encuentre, pero no tienen ningún impacto en la disponibilidad del tiempo de ejecución del recurso. En este inicio rápido, seleccione una región disponible cerca de usted o elija Este de EE. UU.
    Nombre Nombre para el recurso de lenguaje. Este nombre también se usará para crear una dirección URL de punto de conexión que las aplicaciones usarán para enviar solicitudes de API.
    Plan de tarifa Plan de tarifa del recurso de idioma. Puede usar el nivel Gratis F0 para probar el servicio y actualizarlo más adelante a un nivel de pago cuando pase a producción.

    Captura de pantalla que muestra en detalle la creación de un recurso en Azure Portal.

  4. Asegúrese de que la casilla Aviso de IA responsable esté activada.

  5. En la parte inferior de la página, seleccione Revisar y crear.

  6. En la pantalla que aparece, asegúrese de que se ha superado la validación y de que ha escrito la información correctamente. Seleccione Crear.

Obtención de la clave y el punto de conexión

Ahora necesitará la clave y el punto de conexión del recurso para conectar la aplicación a la API. En una sección posterior de este mismo inicio rápido, pegará la clave y el punto de conexión en el código.

  1. Después de que el recurso de lenguaje se implemente correctamente, haga clic en el botón Ir al recurso en Pasos siguientes.

    Captura de pantalla que muestra los pasos siguientes después de implementar un recurso.

  2. En la pantalla del recurso, seleccione Claves y punto de conexión en el menú de navegación izquierdo. Usará una de las claves y el punto de conexión en los pasos siguientes.

    Captura de pantalla en la que se muestra la sección de claves y punto de conexión de un recurso.

Creación de variables de entorno

La aplicación debe autenticarse para enviar solicitudes de API. En el caso de producción, use una forma segura de almacenar sus credenciales y acceder a ellas. En este ejemplo, escribirá las credenciales en variables de entorno del equipo local que ejecuta la aplicación.

Sugerencia

No incluya la clave directamente en el código ni la exponga nunca públicamente. Consulte el artículo de Seguridad de los servicios de Azure AI para ver más opciones de autenticación, como Azure Key Vault.

Para establecer la variable de entorno para la clave del recurso de lenguaje, abra una ventana de consola y siga las instrucciones correspondientes a su sistema operativo y su entorno de desarrollo.

  1. Para establecer la variable de entorno LANGUAGE_KEY, reemplace your-key por una de las claves del recurso.
  2. Para establecer la variable de entorno LANGUAGE_ENDPOINT, reemplace your-endpoint por el punto de conexión del recurso.
setx LANGUAGE_KEY your-key

setx LANGUAGE_ENDPOINT your-endpoint

Nota:

Si solo necesita acceder a las variables de entorno en la consola que se está ejecutando en este momento, puede establecer la variable de entorno con set en vez de con setx.

Después de agregar las variables de entorno, puede que tenga que reiniciar todos los programas en ejecución que necesiten leer la variable de entorno, incluida la ventana de consola. Por ejemplo, si usa Visual Studio como editor, reinícielo antes de ejecutar el ejemplo.

Creación de un archivo JSON con el cuerpo de la solicitud de ejemplo

En un editor de código, cree un archivo denominado test_entitylinking_payload.json y copie el JSON de ejemplo siguiente. Esta solicitud de ejemplo se enviará a la API en el paso siguiente.

{
    "kind": "EntityLinking",
    "parameters": {
        "modelVersion": "latest"
    },
    "analysisInput":{
        "documents":[
            {
                "id":"1",
                "language":"en",
                "text": "Microsoft was founded by Bill Gates and Paul Allen on April 4, 1975."
            }
        ]
    }
}

Guarde test_entitylinking_payload.json en algún lugar del equipo. Por ejemplo, el escritorio.

Envío de una solicitud de API de vinculación de entidad

Use los comandos siguientes para enviar la solicitud de API mediante el programa que usa. Copie el comando en el terminal y ejecútelo.

parámetro Descripción
-X POST <endpoint> Especifica el punto de conexión para acceder a la API.
-H Content-Type: application/json Tipo de contenido para enviar datos JSON.
-H "Ocp-Apim-Subscription-Key:<key> Especifica la clave para acceder a la API.
-d <documents> JSON que contiene los documentos que desea enviar.

Sustituya C:\Users\<myaccount>\Desktop\test_entitylinking_payload.json por la ubicación del archivo de solicitud JSON de ejemplo que ha creado en el paso anterior.

Símbolo del sistema

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_entitylinking_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_entitylinking_payload.json"

Respuesta JSON

{
	"kind": "EntityLinkingResults",
	"results": {
		"documents": [{
			"id": "1",
			"entities": [{
				"bingId": "a093e9b9-90f5-a3d5-c4b8-5855e1b01f85",
				"name": "Microsoft",
				"matches": [{
					"text": "Microsoft",
					"offset": 0,
					"length": 9,
					"confidenceScore": 0.48
				}],
				"language": "en",
				"id": "Microsoft",
				"url": "https://en.wikipedia.org/wiki/Microsoft",
				"dataSource": "Wikipedia"
			}, {
				"bingId": "0d47c987-0042-5576-15e8-97af601614fa",
				"name": "Bill Gates",
				"matches": [{
					"text": "Bill Gates",
					"offset": 25,
					"length": 10,
					"confidenceScore": 0.52
				}],
				"language": "en",
				"id": "Bill Gates",
				"url": "https://en.wikipedia.org/wiki/Bill_Gates",
				"dataSource": "Wikipedia"
			}, {
				"bingId": "df2c4376-9923-6a54-893f-2ee5a5badbc7",
				"name": "Paul Allen",
				"matches": [{
					"text": "Paul Allen",
					"offset": 40,
					"length": 10,
					"confidenceScore": 0.54
				}],
				"language": "en",
				"id": "Paul Allen",
				"url": "https://en.wikipedia.org/wiki/Paul_Allen",
				"dataSource": "Wikipedia"
			}, {
				"bingId": "52535f87-235e-b513-54fe-c03e4233ac6e",
				"name": "April 4",
				"matches": [{
					"text": "April 4",
					"offset": 54,
					"length": 7,
					"confidenceScore": 0.38
				}],
				"language": "en",
				"id": "April 4",
				"url": "https://en.wikipedia.org/wiki/April_4",
				"dataSource": "Wikipedia"
			}],
			"warnings": []
		}],
		"errors": [],
		"modelVersion": "2021-06-01"
	}
}

Limpieza de recursos

Si quiere limpiar y eliminar una suscripción de servicios de Azure AI, puede eliminar el recurso o el grupo de recursos. Al eliminar el grupo de recursos, también se elimina cualquier otro recurso que esté asociado a él.

Pasos siguientes