Instalación y ejecución de contenedores de Extracción de frases clave
Los contenedores permiten hospedar la API de Extracción de frases clave en su propia infraestructura. Si tiene requisitos de seguridad o requisitos de gobernanza de datos que no se pueden cumplir llamando a Extracción de frases clave de forma remota, los contenedores podrían ser una buena opción.
Nota
- La cuenta gratuita se limita a 5000 registros de texto al mes y solo los planes de tarifaGratis y Estándar son válidos para los contenedores. Para obtener más información sobre las tasas de solicitudes de las transacciones, consulte Límites de datos y del servicio.
Los contenedores permiten ejecutar las API de Extracción de frases clave en su propio entorno y son ideales para sus requisitos específicos de seguridad y gobernanza de datos. Los contenedores de Extracción de frases clave proporcionan un procesamiento avanzado de lenguaje natural sobre texto sin formato, e incluye tres funciones principales: análisis de sentimiento, extracción de frases clave y detección de idioma.
Prerrequisitos
- Si no tiene una suscripción a Azure, cree una cuenta gratuita.
- Docker instalado en un equipo host. Docker debe configurarse para permitir que los contenedores se conecten con Azure y envíen datos de facturación a dicho servicio.
- En Windows, Docker también debe estar configurado de forma que admita los contenedores de Linux.
- Debe estar familiarizado con los conceptos de Docker.
- Un recurso de idioma con el plan de tarifa gratis (F0) o estándar (S).
Recopilación de todos los parámetros obligatorios
Se requieren tres parámetros principales para todos los contenedores Azure AI. Los Términos de licencia del software de Microsoft deben estar presentes con el valor Acepto. También se necesitan un URI de punto de conexión y una clave de API.
URI de punto de conexión
El valor de {ENDPOINT_URI} está disponible en la página Información general de Azure Portal del recurso de servicios de Azure AI correspondiente. Vaya a la página Información general, mantenga el puntero sobre el punto de conexión y aparecerá un icono Copiar en el Portapapeles. Copie y use el punto de conexión cuando sea necesario.
Teclas
El valor {API_KEY} se usa para iniciar el contenedor y está disponible en la página Claves de Azure Portal del recurso de servicios de Azure AI correspondiente. Vaya a la página Claves y seleccione el icono Copiar en el Portapapeles.
Importante
Estas claves de suscripción se usan para acceder a la API de servicios de Azure AI. No comparta sus claves. Almacénelas de forma segura. Por ejemplo, use Azure Key Vault. También se recomienda volver a generar estas claves con regularidad. Solo se necesita una clave para realizar una llamada API. Al volver a generar la primera clave, puede usar la segunda para seguir teniendo acceso al servicio.
Recomendaciones y requisitos del equipo host
El host es un equipo basado en x64 que ejecuta el contenedor de Docker. Puede ser un equipo del entorno local o un servicio de hospedaje de Docker incluido en Azure, como:
- Azure Kubernetes Service.
- Azure Container Instances.
- Un clúster de Kubernetes implementado en Azure Stack. Para obtener más información, consulte Implementación de Kubernetes en Azure Stack.
En la tabla siguiente se describen las especificaciones mínima y recomendada para los contenedores de Extracción de frases clave disponibles. Cada núcleo de CPU debe ser de 2,6 gigahercios (GHz) como mínimo. También se enumeran las transacciones permitidas por segundo (TPS).
| Especificaciones de host mínimas | Especificaciones de host recomendadas | TPS mínimas | TPS máximas | |
|---|---|---|---|---|
| Extracción de frases clave | 1 núcleo, 2 GB de memoria | 1 núcleo, 4 GB de memoria | 15 | 30 |
El núcleo de CPU y la memoria corresponden a los valores de --cpus y --memory que se usan como parte del comando docker run.
Obtención de la imagen del contenedor con docker pull
La imagen de contenedor Extracción de frases clave se puede encontrar en el sindicato de registro de contenedor mcr.microsoft.com. Reside en el repositorio azure-cognitive-services/textanalytics/ y se denomina keyphrase. El nombre completo de la imagen de contenedor es mcr.microsoft.com/azure-cognitive-services/textanalytics/keyphrase.
Para usar la versión más reciente del contenedor, puede usar la etiqueta latest. También puede encontrar una lista completa de etiquetas en el MCR.
Use el comando docker pull para descargar la imagen de contenedor del Registro de contenedor de Microsoft.
docker pull mcr.microsoft.com/azure-cognitive-services/textanalytics/keyphrase:latest
Sugerencia
Puede usar el comando docker images para enumerar las imágenes de contenedor descargadas. Por ejemplo, el comando siguiente muestra el id., el repositorio y la etiqueta de cada imagen de contenedor descargada, con formato de tabla:
docker images --format "table {{.ID}}\t{{.Repository}}\t{{.Tag}}"
IMAGE ID REPOSITORY TAG
<image-id> <repository-path/name> <tag-name>
Ejecute el contenedor con docker run.
Una vez que el contenedor esté en el equipo host, use el comando docker run para ejecutar los contenedores. El contenedor continuará ejecutándose hasta que lo detenga.
Importante
- Los comandos de Docker de las secciones siguientes usan la barra diagonal inversa,
\, como un carácter de continuación de línea. Puede quitarla o reemplazarla en función de los requisitos del sistema operativo del host. - Para poder ejecutar el contenedor, las opciones
Eula,BillingyApiKeydeben estar especificadas; de lo contrario, el contenedor no se iniciará. Para obtener más información, vea Facturación. - Los contenedores de análisis de sentimiento y detección de idioma usan la versión v3 de la API y están disponibles con carácter general. El contenedor de Extracción de frases clave usa la versión 2 de la API y está en versión preliminar.
Para ejecutar el contenedor Extracción de frases clave, ejecute el siguiente comando docker run. Reemplace los marcadores de posición por sus propios valores:
| Marcador de posición | Value | Formato o ejemplo |
|---|---|---|
| {CLAVE_API} | Clave del recurso Extracción de frases clave. Puede encontrarla en la página Clave y punto de conexión del recurso en Azure Portal. | xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx |
| {URI_PUNTODECONEXIÓN} | Punto de conexión para acceder a la API de Extracción de frases clave. Puede encontrarla en la página Clave y punto de conexión del recurso en Azure Portal. | https://<your-custom-subdomain>.cognitiveservices.azure.com |
docker run --rm -it -p 5000:5000 --memory 4g --cpus 1 \
mcr.microsoft.com/azure-cognitive-services/textanalytics/keyphrase \
Eula=accept \
Billing={ENDPOINT_URI} \
ApiKey={API_KEY}
Este comando:
- Ejecuta un contenedor de extracción de frases clave desde la imagen de contenedor.
- Asigna un núcleo de CPU y 4 gigabytes (GB) de memoria.
- Expone el puerto TCP 5000 y asigna un seudo-TTY para el contenedor.
- Una vez que se produce la salida, quita automáticamente el contenedor. La imagen del contenedor sigue estando disponible en el equipo host.
Ejecución de varios contenedores en el mismo host
Si tiene pensado ejecutar varios contenedores con puertos expuestos, asegúrese de que ejecuta cada contenedor con un puerto expuesto diferente. Por ejemplo, ejecute el primer contenedor en el puerto 5000 y el segundo en el puerto 5001.
Puede tener este contenedor y un contenedor de servicios de Azure AI diferente en ejecución simultáneamente en el HOST. También puede tener varios contenedores del mismo contenedor de servicios de Azure AI en ejecución.
Consulta del punto de conexión de predicción del contenedor
El contenedor proporciona varias API de puntos de conexión de predicción de consultas basadas en REST.
Utilice el host, http://localhost:5000, con las API de contenedor.
Comprobación de que un contenedor está en ejecución
Hay varias maneras de comprobar que el contenedor está en ejecución. Busque la dirección IP externa y el puerto expuesto del contenedor en cuestión y abra el explorador web que prefiera. Use las distintas direcciones URL de solicitud que se indican a continuación para validar que el contenedor se está ejecutando. Las direcciones URL de solicitud de ejemplo que se enumeran aquí son http://localhost:5000, pero el contenedor específico puede variar. Asegúrese de confiar en la dirección IP externa y el puerto expuesto del contenedor.
| URL de la solicitud | Propósito |
|---|---|
http://localhost:5000/ |
El contenedor ofrece una página principal. |
http://localhost:5000/ready |
Esta URL, solicitada con GET, proporciona una comprobación de que el contenedor está listo para aceptar una consulta para el modelo. Esta solicitud se puede usar con los sondeos de ejecución y preparación de Kubernetes. |
http://localhost:5000/status |
Esta URL, también solicitada con GET, comprueba si el valor de api-key usado para iniciar el contenedor es válido sin generar una consulta de punto de conexión. Esta solicitud se puede usar con los sondeos de ejecución y preparación de Kubernetes. |
http://localhost:5000/swagger |
El contenedor cuenta con un completo conjunto de documentación sobre los puntos de conexión y una característica de prueba. Esta característica le permite especificar la configuración en un formulario HTML basado en web y realizar la consulta sin necesidad de escribir código. Una vez que la consulta devuelve resultados, se proporciona un ejemplo del comando CURL para mostrar los encabezados HTTP y el formato de cuerpo requeridos. |
Ejecutar el contenedor desconectado de Internet
Para usar este contenedor desconectado de Internet, primero debe solicitar acceso rellenando una solicitud y comprando un plan de compromiso. Consulte Uso de contenedores de Docker en entornos desconectados para más información.
Si ha sido aprobado para ejecutar el contenedor desconectado de Internet, use el ejemplo siguiente que muestra el formato del comando docker run que se va a usar, con valores de marcador de posición. Reemplace estos valores por los suyos.
El parámetro DownloadLicense=True en el comando docker run descargará un archivo de licencia que permitirá que el contenedor de Docker se ejecute sin estar conectado a Internet. También contiene una fecha de expiración, tras la cual el archivo de licencia no será válido para ejecutar el contenedor. Los archivos de licencia solo se pueden con el contenedor adecuado para el que se ha recibido aprobación. Por ejemplo, no se puede usar un archivo de licencia para un contenedor de conversión de voz en texto con un contenedor de Documento de inteligencia.
| Marcador de posición | Value | Formato o ejemplo |
|---|---|---|
{IMAGE} |
Imagen de contenedor que desea usar. | mcr.microsoft.com/azure-cognitive-services/form-recognizer/invoice |
{LICENSE_MOUNT} |
Ruta de acceso en que se descargará y montará la licencia. | /host/license:/path/to/license/directory |
{ENDPOINT_URI} |
Punto de conexión para autenticar la solicitud de servicio. Puede encontrarla en la página Clave y punto de conexión del recurso en Azure Portal. | https://<your-custom-subdomain>.cognitiveservices.azure.com |
{API_KEY} |
Clave del recurso de Text Analytics. Puede encontrarla en la página Clave y punto de conexión del recurso en Azure Portal. | xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx |
{CONTAINER_LICENSE_DIRECTORY} |
Ubicación de la carpeta de licencias en el sistema de archivos local del contenedor. | /path/to/license/directory |
docker run --rm -it -p 5000:5000 \
-v {LICENSE_MOUNT} \
{IMAGE} \
eula=accept \
billing={ENDPOINT_URI} \
apikey={API_KEY} \
DownloadLicense=True \
Mounts:License={CONTAINER_LICENSE_DIRECTORY}
Una vez descargado el archivo de licencia, el contenedor se puede ejecutar en un entorno desconectado. En el ejemplo siguiente se muestra el formato del comando docker run que se va a usar, con valores de marcador de posición. Reemplace estos valores por los suyos.
Cada vez que se ejecute el contenedor, es preciso montar el archivo de licencia en el contenedor y la ubicación de la carpeta de licencias en el sistema de archivos local del contenedor debe especificarse con Mounts:License=. También se debe especificar un montaje de salida para que se puedan escribir registros de uso de facturación.
| Marcador de posición | Value | Formato o ejemplo |
|---|---|---|
{IMAGE} |
Imagen de contenedor que desea usar. | mcr.microsoft.com/azure-cognitive-services/form-recognizer/invoice |
{MEMORY_SIZE} |
Tamaño adecuado de la memoria que se asignará al contenedor. | 4g |
{NUMBER_CPUS} |
Número apropiado de procesadores que se asignan a un contenedor. | 4 |
{LICENSE_MOUNT} |
Ruta de acceso en la que se encontrará y montará la licencia. | /host/license:/path/to/license/directory |
{OUTPUT_PATH} |
Ruta de acceso de salida para registrar los registros de uso. | /host/output:/path/to/output/directory |
{CONTAINER_LICENSE_DIRECTORY} |
Ubicación de la carpeta de licencias en el sistema de archivos local del contenedor. | /path/to/license/directory |
{CONTAINER_OUTPUT_DIRECTORY} |
Ubicación de la carpeta de salida en el sistema de archivos local del contenedor. | /path/to/output/directory |
docker run --rm -it -p 5000:5000 --memory {MEMORY_SIZE} --cpus {NUMBER_CPUS} \
-v {LICENSE_MOUNT} \
-v {OUTPUT_PATH} \
{IMAGE} \
eula=accept \
Mounts:License={CONTAINER_LICENSE_DIRECTORY}
Mounts:Output={CONTAINER_OUTPUT_DIRECTORY}
Detención del contenedor
Para apagar el contenedor, en el entorno de la línea de comandos donde se ejecuta el contenedor, seleccione Ctrl + C.
Solución de problemas
Si ejecuta el contenedor con un montaje de salida y el registro habilitados, el contenedor genera archivos de registro que resultan útiles para solucionar problemas que se producen al iniciar o ejecutar el contenedor.
Sugerencia
Para obtener más información e instrucciones para solucionar problemas, consulte Preguntas frecuentes sobre los contenedores de Azure AI (P+F).
Facturación
Los contenedores Extracción de frases clave envían información de facturación a Azure mediante un recurso de Extracción de frases clave en su cuenta de Azure.
Las consultas en el contenedor se facturan con el plan de tarifa del recurso de Azure que se usa para el parámetro ApiKey.
Los contenedores de servicios de Azure AI no tienen licencia para ejecutarse si no están conectados al punto de conexión de medición o facturación. Debe habilitar los contenedores para que comuniquen la información de facturación al punto de conexión de facturación en todo momento. Los contenedores de servicios de Azure AI no envían datos de los clientes (por ejemplo, la imagen o el texto que se está analizando) a Microsoft.
Conexión con Azure
El contenedor necesita que se ejecuten los valores del argumento de facturación. Estos valores permiten al contenedor conectarse al punto de conexión de facturación. El contenedor informa sobre el uso cada 10 a 15 minutos. Si el contenedor no se conecta a Azure en la ventana de tiempo permitida, continuará ejecutándose pero no atenderá las consultas hasta que se restaure el punto de conexión de facturación. Se intenta 10 veces la conexión en el mismo intervalo de tiempo de 10 a 15 minutos. Si no se puede conectar con el punto de conexión de facturación en esos 10 intentos, el contenedor deja de atender solicitudes. Consulte Preguntas más frecuentes acerca de los contenedores de servicios de Azure AI para obtener un ejemplo de la información que se envía a Microsoft para la facturación.
Argumentos de facturación
El comando docker run iniciará el contenedor cuando se especifiquen las tres opciones siguientes con valores válidos:
| Opción | Descripción |
|---|---|
ApiKey |
La clave de API del recurso de servicios de Azure AI que se usa para realizar un seguimiento de la información de facturación. El valor de esta opción se debe establecer en una clave de API para el recurso aprovisionado que se especifica en Billing. |
Billing |
El punto de conexión del recurso de servicios de Azure AI que se usa para realizar el seguimiento de la información de facturación. El valor de esta opción debe establecerse en el URI del punto de conexión de un recurso aprovisionado de Azure. |
Eula |
Indica que ha aceptado la licencia del contenedor. El valor de esta opción debe establecerse en accept. |
\
Resumen
En este artículo, ha aprendido los conceptos y el flujo de trabajo para la descarga, instalación y ejecución de contenedores de Extracción de frases clave. En resumen:
- Extracción de frases clave proporciona contenedores de Linux para Docker.
- Las imágenes del contenedor se descargan desde Microsoft Container Registry (MCR).
- Las imágenes de contenedor se ejecutan en Docker.
- Puede usar la API de REST o el SDK para llamar a operaciones en contenedores de Extracción de frases clave mediante la especificación del URI del host del contenedor.
- Debe especificar la información de facturación al crear una instancia de un contenedor.
Importante
Los contenedores de Azure AI no tienen licencia para ejecutarse sin estar conectados a Azure para realizar mediciones. Los clientes tienen que habilitar los contenedores para comunicar la información de facturación con el servicio de medición en todo momento. Los contenedores de Azure AI no envían datos de los clientes (por ejemplo, el texto que se está analizando) a Microsoft.
Pasos siguientes
- Para ver las opciones de configuración, consulte Configuración de contenedores.