Nota:
El acceso a esta página requiere autorización. Puede intentar iniciar sesión o cambiar directorios.
El acceso a esta página requiere autorización. Puede intentar cambiar los directorios.
La API de Proofreader es una API web experimental que permite corregir errores gramaticales, ortográficos y de puntuación en texto mediante un pequeño modelo de lenguaje (SLM) integrado en Microsoft Edge, desde el código JavaScript de tu sitio web o extensión del explorador.
Para obtener información introductoria sobre la API de Proofreader, consulte Explicador de la API de Proofreader.
Contenido detallado:
- Disponibilidad de la API Proofreader
- Decidir qué API usar
- El modelo de instrucción de Aion
- Habilitar la API de Proofreader
- Vea un ejemplo práctico
- Uso de la API de Proofreader
- Enviar comentarios
- Ver también
Disponibilidad de la API Proofreader
La API Proofreader está disponible como versión preliminar para desarrolladores en Microsoft Edge a partir de la versión 158. Puede probar la API de Proofreader localmente en Microsoft Edge, solo en su dispositivo. Consulte Habilitar la API del lector de pruebas, a continuación.
La API de Proofreader está optimizada para corregir errores gramaticales, ortográficos y de puntuación en el contenido del texto. Para obtener más información sobre una alternativa para escenarios de ingeniería de mensajes más personalizados a los que estas API pueden no servir, consulte Prompt a built-in language model with the Prompt API.
Decidir qué API usar
Para aprovechar las capacidades de IA en sitios web y extensiones de explorador, también puede usar los métodos siguientes:
Envíe solicitudes de red a servicios de inteligencia artificial basados en la nube, como las soluciones de IA de Azure.
Ejecute modelos de IA locales mediante la API de red neuronal web (WebNN) o el tiempo de ejecución para web de ONNX.
La API de Proofreader usa un modelo de lenguaje pequeño (SLM) que se ejecuta en el mismo dispositivo donde se usan las entradas y salidas del modelo (es decir, localmente). Esto tiene las siguientes ventajas en comparación con las soluciones basadas en la nube:
Costo reducido: No hay ningún costo asociado con el uso de un servicio de IA en la nube.
Independencia de la red: Más allá de la descarga inicial del modelo, no hay latencia de red al solicitar el modelo y el modelo también se puede usar cuando el dispositivo está sin conexión.
Privacidad mejorada: Los datos que se introducen en el modelo nunca abandonan el dispositivo y no se recopilan (por ejemplo, para entrenar modelos de inteligencia artificial).
La API de Proofreader usa un modelo proporcionado por Microsoft Edge e integrado en el explorador, lo que ofrece ventajas adicionales sobre las soluciones locales personalizadas, como las basadas en WebGPU, WebNN o WebAssembly:
Costo pago único compartido: El modelo proporcionado por el explorador se descarga cuando se llama a la API por primera vez y, a continuación, el modelo se comparte en todos los sitios web que se ejecutan en el explorador, lo que reduce los costos de red para desarrolladores y usuarios.
Uso simplificado para desarrolladores web: El modelo integrado se puede ejecutar mediante el uso de API web sencillas y no requiere conocimientos de IA/ML ni el uso de marcos de terceros.
El modelo de instrucción de Aion
En Microsoft Edge, la API Proofreader utiliza el modelo Aion Instruct, que está integrado en el explorador. Aion Instruct es un modelo de lenguaje pequeño de 2,3 mil millones de parámetros que sobresale en tareas basadas en texto. Para obtener más información sobre el modelo, consulte la tarjeta de modelo microsoft/Aion-1.0-Instruct-2.3B, en Hugging Face.
Aviso de declinación de responsabilidades
Al igual que otros modelos de lenguaje de este tamaño, Aion Instruct puede comportarse de manera poco fiable, inexacta, injusta u ofensiva. Debe tener en cuenta los riesgos de pasar contenido que no es de confianza al modelo y validar el origen y la integridad del contenido antes de usar el contenido como entrada del modelo. Para obtener más información, consulte Bias, Risks, and Limitations, en microsoft/Aion-1.0-Instruct-2.3B, en Hugging Face.
Requisitos de hardware
La versión preliminar para desarrolladores de la API Proofreader está pensada para funcionar en dispositivos que tienen capacidades de hardware que producen resultados de Modelo de lenguaje pequeño (SLM) que tienen una calidad y latencia predecibles.
La API de Proofreader tiene los siguientes requisitos:
Sistemas operativos:
- Windows 10 u 11.
- macOS 13.3 o posterior.
- Linux de 64 bits (x64) con controladores de GPU Vulkan y Microsoft Edge 159 o posterior.
Almacenamiento: Al menos 20 GB disponibles en el volumen que contiene el perfil de Edge. Si el almacenamiento disponible cae por debajo de 5 GB, el modelo se eliminará para garantizar que otras características del explorador tengan suficiente espacio para funcionar.
GPU: 3 GB de VRAM o más.
Red: Plan de datos ilimitado o conexión no medida. El modelo no se descarga si se usa una conexión de uso medido.
Para comprobar si el dispositivo es compatible con la versión preliminar para desarrolladores de la API Proofreader, consulte Habilitar la API Proofreader a continuación y compruebe la clase de rendimiento del dispositivo.
Debido a la naturaleza experimental de la API de Proofreader, es posible que observe problemas en configuraciones de hardware específicas. Si ve problemas en configuraciones de hardware específicas, envíe comentarios abriendo un nuevo problema en el repositorio de MSEdgeExplainers.
Disponibilidad del modelo de instrucción de Aion
Se requiere una descarga inicial del modelo de instrucción de Aion la primera vez que un sitio web llama a una API que requiere un modelo en el dispositivo. Para supervisar la descarga del modelo, utilice la monitor opción al crear una nueva sesión de la API de Proofreader. Consulte Supervisar el progreso de la descarga del modelo, a continuación.
El modelo no está disponible en las siguientes condiciones:
- Si la opción IA en el dispositivo está deshabilitada, en Configuración>,Copilot e IA.
- Si las directivas empresariales GenAILocalFoundationalModelSettings o ComponentUpdatesEnabled están configuradas para bloquear la descarga del modelo.
- Si el dispositivo no cumple los requisitos de hardware, espacio en disco o red.
Consideración para Edge Canary, Dev y Beta
En Microsoft Edge Canary, Dev y Beta, la opción de IA en el dispositivo está deshabilitada de forma predeterminada en Configuración>Copilot e IA, para evitar descargar el modelo por separado para cada canal.
Si habilita la marca de la API Proofreader en edge://flags, la opción de IA en el dispositivo se habilita automáticamente en Canary, Dev y Beta. Consulte Habilitar la API del lector de pruebas, a continuación.
Habilitar la API de Proofreader
Para usar la API Proofreader en Microsoft Edge:
Asegúrese de que usa Microsoft Edge versión 158 o posterior.
En Microsoft Edge, abra una nueva pestaña o ventana y, a continuación, vaya a
edge://flags.En el cuadro de búsqueda, en la parte superior de la página, escriba Proofreader API.
La página se filtra para mostrar la bandera coincidente.
Seleccione Habilitado junto a la marca de la API de Proofreader :
Opcionalmente, para registrar localmente la información que puede ser útil para la depuración de problemas, habilite también la marca Habilitar registros de depuración del modelo de IA en el dispositivo .
Reinicia Microsoft Edge.
Para comprobar si el dispositivo cumple los requisitos de hardware para la versión preliminar para desarrolladores de la API Proofreader, abra una nueva pestaña, vaya a
edge://on-device-internalsy compruebe el valor de clase de rendimiento del dispositivo .Si la clase de rendimiento del dispositivo es Media o superior, se espera que la API Proofreader sea compatible con el dispositivo. Si sigue experimentando problemas, envíe un nuevo problema.
Vea un ejemplo práctico
Para ver la API Proofreader en acción y examinar el código existente que usa estas API:
Habilite la API de Proofreader, como se describe anteriormente.
En Microsoft Edge, abra una pestaña o ventana y vaya al área de juegos de la API del corrector de pruebas.
En el banner de información en la parte superior, compruebe el estado. El estado inicialmente dice API en el dispositivo y descarga de modelos:
Una vez descargado el modelo, el banner de información indica API en el dispositivo y modelo disponibles, lo que indica que se pueden usar la API y el modelo:
Si el modelo no inicia la descarga, reinicia Microsoft Edge y vuelve a intentarlo.
La API de Proofreader solo se admite en dispositivos que cumplan ciertos requisitos de hardware. Para obtener más información, consulta Requisitos de hardware más arriba.
Si quiere, puede cambiar el contenido y la configuración de la página. Por ejemplo, modifique el texto para corregirlo o cambiar el idioma de entrada esperado.
Haga clic en el botón Revisar , en la parte inferior de la página.
El resultado se genera en la sección de respuestas de la página:
Vea también:
- /built-in-ai/ - Léame y código fuente para la demostración de áreas de juego de IA integrada.
Uso de la API de Proofreader
Compruebe si la API está habilitada
Antes de usar la API Proofreader en el código de su sitio web, verifique que la API esté habilitada, probando la Proofreader presencia del objeto:
if (!Proofreader) {
// The Proofreader API is not available.
}
Compruebe si el modelo se puede utilizar
La API del corrector de pruebas solo se puede usar si el dispositivo admite la ejecución del modelo y después de que Microsoft Edge haya descargado el modelo de lenguaje y el tiempo de ejecución del modelo.
Para comprobar si se puede usar la API, use el availability() método:
const availability = await Proofreader.availability();
if (availability == "unavailable") {
// The model is not available.
}
if (availability == "downloadable" || availability == "downloading") {
// The model can be used, but it needs to be downloaded first.
}
if (availability == "available") {
// The model is available and can be used.
}
Crear una sesión nueva
Al crear una sesión, se indica al explorador que cargue el modelo de lenguaje en la memoria para que se pueda usar. Antes de que pueda usar la API Proofreader para corregir texto, cree una nueva sesión mediante el create() método:
// Create a Proofreader session.
const session = await Proofreader.create();
Para personalizar la sesión del modelo, puede pasar opciones al create() método:
// Create a Proofreader session with options.
const session = await Proofreader.create(options);
Las opciones disponibles se enumeran a continuación:
| Opción | Descripción |
|---|---|
monitor |
Función que se usa para supervisar el progreso de la descarga del modelo. Consulte Supervisar el progreso de la descarga del modelo, a continuación. |
expectedInputLanguages |
Matriz de cadenas de caracteres. Cada cadena es un idioma que se espera que contenga el texto de entrada. Por ejemplo: ["en", "es"]. |
Supervisar el progreso de la descarga del modelo
Para seguir el progreso de la descarga del modelo, use la monitor opción. Esto es útil cuando el modelo aún no se ha descargado completamente en el dispositivo en el que se utilizará el modelo, para informar a los usuarios de su sitio web que deben esperar.
// Create a Proofreader session with the monitor option to monitor the model
// download.
const session = await Proofreader.create({
monitor: m => {
// Use the monitor object argument to add an listener for the
// downloadprogress event.
m.addEventListener("downloadprogress", event => {
// The event is an object with the loaded and total properties.
if (event.loaded == event.total) {
// The model is fully downloaded.
} else {
// The model is still downloading.
const percentageComplete = (event.loaded / event.total) * 100;
}
});
}
});
Ejecutar la API del corrector de pruebas
Para generar texto revisado mediante la API de Proofreader, después de haber creado la sesión de modelo correspondiente, use el session.proofread() método. Este método devuelve una promesa que se resuelve después de que la API Proofreader haya terminado de generar el texto corregido.
// Create a Proofreader session.
const session = await Proofreader.create();
// Correct the text and wait for the result.
const result = await session.proofread(textToBeCorrected);
// Use the result.
console.log(result);
Usar el resultado de la API de Proofreader
El session.proofread() método devuelve una promesa que se resuelve en un objeto que tiene las siguientes propiedades:
| Propiedad | Descripción |
|---|---|
correctedInput |
El texto corregido, como una cadena. |
corrections |
Una matriz de objetos de corrección. |
Un objeto de corrección tiene las siguientes propiedades:
| Propiedad | Descripción |
|---|---|
startIndex |
El índice del primer carácter del texto de entrada que se corrigió. |
endIndex |
El índice del último carácter, en el texto de entrada, que se corrigió. |
correction |
La cadena que reemplaza el texto incorrecto. |
El ejemplo siguiente muestra cómo utilizar el resultado del session.proofread() método:
// Create a Proofreader session.
const session = await Proofreader.create();
// Correct the text and wait for the result.
const result = await session.proofread(textToBeCorrected);
// Log the corrected text.
console.log("Corrected text:", result.correctedInput);
// Log each correction.
result.corrections.forEach(({ startIndex, endIndex, correction }) => {
const initialText = textToBeCorrected.slice(startIndex, endIndex);
console.log(`Replaced text "${initialText}" (index ${startIndex} to ${endIndex}) with "${correction}"`);
});
Destruir una sesión
Destruya la sesión para que el explorador sepa que ya no necesita el modelo de lenguaje, de modo que el modelo se pueda descargar de la memoria.
Puedes destruir una sesión de dos maneras distintas:
- Mediante el
destroy()método. - Al usar un
AbortControllercomando .
Destruir una sesión mediante el método destroy()
Puede utilizar el session.destroy() método para destruir una sesión de Proofreader:
const session = await Proofreader.create();
// Later, destroy the session by using the destroy method.
session.destroy();
Destruir una sesión con un AbortController
Como alternativa, puede crear un AbortController objeto, crear una Proofreader sesión y, a continuación, llamar a abort():
// Create an AbortController object.
const controller = new AbortController();
// Create a Proofreader session and pass the
// AbortController signal object by using the signal option.
const session = await Proofreader.create({ signal: controller.signal });
// Later, such as when the user interacts with the UI, destroy the session by
// calling the abort() function of the AbortController object.
controller.abort();
Enviar comentarios
Estamos muy interesados en conocer la gama de escenarios para los que piensa usar la API de Proofreader, cualquier problema con la API o el modelo de lenguaje, y si las nuevas API específicas de tareas serían útiles.
Para enviar comentarios sobre los escenarios y las tareas que desea realizar, agregue un comentario al problema de comentarios de la API de Proofreader.
Si observa algún problema al usar la API en su lugar, infórmelo en el repositorio.
También puede contribuir a la discusión sobre el diseño de la API Proofreader en el repositorio del W3C Web Machine Learning Working Group.
Vea también
- Proofreader API Explainer, en la Web Repositorio de GitHub Machine Learning.
- Escriba, reescriba y resuma texto con las API de asistencia de escritura.
- Prompt a un modelo de lenguaje integrado con la API Prompt.
- /built-in-ai/ - Código fuente y archivo Léame de la demostración de áreas de juego de IA integrada.