Consejo Rápido: Cómo Usar la API Assist de Android

Spanish (Español) translation by Rafael Chavarría (you can also view the original English article)

Los usuarios de Android hoy en día ya no tienen que abrir un navegador y realizar una búsqueda para aprender sobre cosas con las que se topan mientras usan una aplicación. ¡En su lugar pueden usar un asistente! Si tienes un dispositivo que corre Android 6.0 o superior, podrías estar familiarizado con su asistente por defecto, el cuál inicialmente fue llamado Google Now sobre Tap. Últimamente, su nombre ha sido cambiado a screen search.

Los asistentes, aunque son sensibles al contexto, usualmente no son muy precisos. Para mejorar la precisión, los desarrolladores de aplicaciónes deben usar la API Assist. En este consejo rápido, introduciré los básicos de la API y te ayudaré a comenzar creando tu propio asistente personalizado.

1. Habilitando el Asistente Por Defecto

Si nunca has usado el asistente en tu dispositivo o emulador, probablemente aún no esté habilitado. Para habilitarlo, presiona y mantén presionado el botón de inicio. En el diálogo que aparece, presiona el botón Sí, Estoy dentro.

Ahora podrás acceder al asistente por defecto desde cualquier aplicación simplemente presionando largamente el botón de inicio. Vale la pena notar que el asistente por defecto es parte de la aplicación de Google, y funciona mejor solo después de que te has registrado con tu cuenta de Google.

2. Enviando Información al Asistente

El asistente por defecto es muy poderoso. Puede proporcionar automáticamente información sensible al contexto basado en los contenidos actuales de la pantalla. Lo hace analizando jerárquicamente la vista de la actividad activa.

Para verlo en acción, crea una nueva actividad en tu proyecto de Android Studio y agrega el siguiente widget TextView, el cuál tiene el nombre de una popular novela, a este diseño:

<TextView
    android:layout_width="wrap_content"
    android:layout_height="wrap_content"
    android:text="Alice's Adventures in Wonderland"
    android:id="@+id/my_text"
    />

Si ejecutas tu aplicación ahora y presionas largamente el botón de inicio, el asistente por defecto mostrará tarjetas que se relacionan con los contenidos del widget TextView.

Enviando información adicional al asistente, puedes mejorar su precisión. Para hacerlo, debes anular el método onProvideAssistContent() de tu clase Activity.

1	@Override
2	public void onProvideAssistContent(AssistContent outContent) {
3	super.onProvideAssistContent(outContent);
4	}

Ahora puedes usar el objeto AssistContent para enviar información al asistente. Por ejemplo, si quieres que el asistente muestre una tarjeta que permita al usuario leer acerca de la novela en Goodreads, puedes usar el método setWebUri().

outContent.setWebUri(
    Uri.parse(
      "https://www.goodreads.com/book/show/13023.Alice_in_Wonderland"
    )
);

Aquí está como se ve la nueva tarjeta:

La API Assist también te permite pasar datos estructurados al asistente usando el método setStructuredData(), el cuál espera una cadena JSON-LD. La manera más fácil de general la cadena JSON-LD es usar la clase JSONObject y su método put().

El siguiente código de ejemplo te muestra cómo generar y enviar datos estructurados acerca de la novela:

outContent.setStructuredData(
    new JSONObject()
        .put("@type", "Book")
        .put("author", "Lewis Carroll")
        .put("name", "Alice in Wonderland")
        .put("description", 
            "This is an 1865 novel about a girl named Alice, " + 
            "who falls through a rabbit hole and " +
            "enters a fantasy world."
        ).toString()
);

Si eliges codificar a mano tu cadena JSON-LD, te sugiero que te asegures de que es valida usando la Herramienta de Prueba de Datos Estructurados de Google.

Validating JSON-LD with Structured Data Testing Tool

3. Creando un Asistente Personalizado

Si no estás satisfecho con la manera en la que el asistente de aplicación de Google maneja tus datos, deberías considerar crear tu propio asistente. Hacerlo no toma mucho esfuerzo.

Todos los asistentes personalizados deben tener lo siguiente:

un objeto VoiceInteractionService
un objeto VoiceInteractionSession
un objeto VoiceInteractionSessionService
un archivo de meta-datos XML describiendo al asistente personalizado

Primero, crea una nueva clase Java llamada MyAssistantSession y hazlo una subclase de la clase VoiceInteractionSession En este punto, Android Studio debería generar de manera automática un constructor para esta.

public class MyAssistantSession extends VoiceInteractionSession {
    public MyAssistantSession(Context context) {
        super(context);
    }
}

Invalidando el método onHandleAssist() de la clase, puedes definir el comportamiento de tu asistente. Por ahora, hagamos que pase la cadena JSON-LD que generamos en el paso anterior y mostremos sus contenidos como un mensaje Toast. Como habrás adivinado, para regresar la cadena JSON-LD, debes usar el método getStructureData() del objeto AssistContent.

El siguiente código te muestra cómo mostrar el valor de la llave description de la cadena JSON-LD como un mensaje Toast.

@Override
public void onHandleAssist(Bundle data, 
              AssistStructure structure, AssistContent content) {
    super.onHandleAssist(data, structure, content);

    try {
        // Fetch structured data
        JSONObject structuredData = 
            new JSONObject(content.getStructuredData());
        
        // Display description as Toast
        Toast.makeText(
            getContext(), 
            structuredData.optString("description"),
            Toast.LENGTH_LONG
        ).show();
    } catch (JSONException e) {
        e.printStackTrace();
    }

}

Un objeto VoiceInteractionSession debe ser inicializado dentro de un objeto VoiceInteractionSessionService. Así pues, crea una nueva clase llamada MyAssistantSessionService y hazla una subclase de VoiceInteractionSessionService. Dentro de su método onNewSession(), llama al constructor de MyAssistantSession.

public class MyAssistantSessionService 
                extends VoiceInteractionSessionService {
    @Override
    public VoiceInteractionSession onNewSession(Bundle bundle) {
        return new MyAssistantSession(this);
    }
}

Nuestro asistente también necesita un objeto VoiceInteractionService. De ahí, crea uno llamado MyAssistantService. No tienes que escribir ningún código dentro del el.

1	public class MyAssistantService extends VoiceInteractionService {
2
3	}

Para especificar los detalles de configuración del asistente, debes crear un archivo de metadatos XML y colocarlo en el folder res/xml de tu proyecto. El elemento raíz del archivo debe ser una etiqueta <voice-interaction-service> especificando los nombres completamente calificados en las subclases VoiceInteractionService y VoiceInteractionSessionService.

Aquí está un archivo de metadatos de ejemplo:

<?xml version="1.0" encoding="utf-8"?>
<voice-interaction-service 
    xmlns:android="http://schemas.android.com/apk/res/android"
    android:sessionService="com.tutsplus.myassistantapp.MyAssistantSessionService"
    android:recognitionService="com.tutsplus.myassistantapp.MyAssistantService"
    android:supportsAssist="true"
/>

Por último, mientras declaras los servicios en el archivo AndroidManifest.xml de tu proyecto, asegúrate de que requieren el permiso BIND_VOICE_INTERACTION.

<service android:name=".MyAssistantService"
    android:permission="android.permission.BIND_VOICE_INTERACTION">
  <meta-data android:name="android.voice_interaction"
    android:resource="@xml/assist_metadata" />
  <intent-filter>
    <action android:name="android.service.voice.VoiceInteractionService"/>
  </intent-filter>
</service>

<service android:name=".MyAssistantSessionService"
    android:permission="android.permission.BIND_VOICE_INTERACTION">
</service>

Tu asistente personalizado ahora está listo.

4. Usando el Asistente Personalizado

Para poder usar tu asistente personalizado, debes establecerlo como el asistente por defecto de tu dispositivo Android. Así pues, abre la aplicación de Ajustes y navega a Aplicaciones > Aplicaciones por Defecto > Asistente y entrada de voz. Ahora, da clic en la opción Aplicación Asistente para seleccionar tu asistente.

En este punto, si ejecutas tu aplicación y presionas largamente el botón de inicio, deberías poder ver el mensaje Toast de tu asistente personalizado.

Conclusión

En este consejo rápido, aprendiste cómo usar la API Assist para interactuar con asistentes en la plataforma Android. También aprendiste cómo crear un rudimentario asistente personalizado. Pero una advertencia: debido a que los asistentes pueden leer casi todo el texto que está presente en la pantalla de un usuario, asegúrate de que tu asistente personalizado maneja información sensible de manera segura.

Para aprender más sobre la API Assist, haz referencia a su documentación oficial. Y para aprender más sobre código y APIs de última generación para la plataforma Android, ¡revisa algunos de nuestros otros cursos y tutoriales aquí en Envato Tuts+!