dfcx scrapi

API de secuencias de comandos Python Dialogflow CX (SCRAPI)

Una API de secuencias de comandos de alto nivel para creadores, desarrolladores y mantenedores de bots.

Tabla de contenido

1. Introducción
   • ¿Qué puedo hacer con SCRAPI?
   • Construido con
2. Empezando
   • Configuración del entorno
   • Autenticación
3. Uso
4. Composición de la biblioteca
   • Centro
   • Herramientas
5. Contribuyendo
6. Licencia
7. Contacto
8. Expresiones de gratitud

Introducción

La API de scripting de Python Dialogflow CX (DFCX SCRAPI) es una API de alto nivel que amplía el cliente oficial de Google Python para Dialogflow CX. SCRAPI hace que el uso de DFCX sea más fácil, más amigable y más pitónico para los creadores, desarrolladores y mantenedores de bots.

 SCRAPI --> Python Dialogflow CX
as
Keras --> Tensorflow

¿Qué puedo hacer con DFCX SCRAPI?

Con DFCX SCRAPI puede realizar muchas acciones de creación y mantenimiento de bots a escala, incluidas, entre otras:

• Crear, actualizar, eliminar, obtener y enumerar todos los tipos de recursos CX (es decir, intenciones, tipos de entidades, páginas, flujos, etc.)
• Convierta recursos CX de acceso común en marcos de datos de Pandas
• Mantenga conversaciones totalmente automatizadas con un agente de CX (¡potente para pruebas de regresión!)
• Extraer información de validación
• Extraer información del historial de cambios
• Busque en todos los flujos/páginas/rutas para encontrar un parámetro o expresión específica utilizando las funciones de Search Util
• ¡Mueva rápidamente recursos CX entre agentes usando las funciones Copy Util!
• Cree los objetos protobuf fundamentales que CX utiliza para cada tipo de recurso utilizando métodos de Builder
• ...¡y mucho, mucho más!

Construido con

• Pitón 3.8+

Autenticación

La autenticación puede variar dependiendo de cómo y dónde interactúa con SCRAPI.

colaboración de google

Si usa SCRAPI con una computadora portátil de Google Colab, puede agregar lo siguiente en la parte superior de su computadora portátil para facilitar la autenticación:

 project_id = '<YOUR_GCP_PROJECT_ID>'

# this will launch an interactive prompt that allows you to auth with GCP in a browser
!g cloud auth application - default login - - no - launch - browser

# this will set your active project to the `project_id` above
!g cloud auth application - default set - quota - project $ project_id

Después de ejecutar lo anterior, Colab recogerá sus credenciales del entorno y las pasará directamente a SCRAPI. ¡No es necesario utilizar claves de cuenta de servicio! Luego puedes usar SCRAPI simplemente así:

 from dfcx_scrapi . core . intents import Intents

agent_id = '<YOUR_AGENT_ID>'
i = Intents () # <-- Creds will be automatically picked up from the environment
intents_map = i . get_intents_map ( agent_id )

---

Funciones en la nube / Ejecución en la nube

Si está utilizando SCRAPI con Cloud Functions o Cloud Run, SCRAPI puede aprovechar los créditos del entorno predeterminado utilizados por estos servicios sin ninguna configuración adicional.

1. Agregue dfcx-scrapi a su archivo requirements.txt
2. Asegúrese de que la cuenta de servicio Cloud Function/Cloud Run tenga el rol de IAM de Dialogflow adecuado

Una vez que haya configurado lo anterior, su código de función se puede usar fácilmente de esta manera:

 from dfcx_scrapi . core . intents import Intents

agent_id = '<YOUR_AGENT_ID>'
i = Intents () # <-- Creds will be automatically picked up from the environment
intents_map = i . get_intents_map ( agent_id )

---

Entorno local de Python

De manera similar a Cloud Functions/Cloud Run, SCRAPI puede aprovechar sus credenciales de autenticación local si está utilizando la CLI de gcloud.

1. Instale la CLI de gcloud.
2. Ejecute gcloud init .
3. Ejecute el inicio gcloud auth login
4. Ejecute gcloud auth list para asegurarse de que su cuenta principal esté activa.

Esto autenticará su cuenta principal de GCP con la CLI de gcloud y SCRAPI puede obtener los créditos desde aquí.

---

Excepciones y misceláneos.

Hay algunas clases en SCRAPI que todavía dependen de claves de cuenta de servicio, en particular la clase DataframeFunctions debido a cómo se autentica con Google Sheets.

Para utilizar estas funciones, necesitará una cuenta de servicio que tenga acceso adecuado a su proyecto de GCP.
Para obtener más información y ver la documentación oficial de las cuentas de servicio, vaya a Creación y administración de cuentas de servicio de GCP.

Una vez que haya obtenido una clave de cuenta de servicio con los permisos adecuados, podrá usarla de la siguiente manera:

 from dfcx_scrapi . core . intents import Intents
from dfcx_scrapi . tools . dataframe_functions import DataframeFunctions

agent_id = '<YOUR_AGENT_ID>'
creds_path = '<PATH_TO_YOUR_SERVICE_ACCOUNT_JSON_FILE>'

i = Intents ( creds_path = creds_path )
dffx = DataframeFunctions ( creds_path = creds_path )

df = i . bulk_intent_to_df ( agent_id )
dffx . dataframe_to_sheets ( 'GOOGLE_SHEET_NAME' , 'TAB_NAME' , df )

Empezando

Configuración del entorno

Configure las credenciales de Google Cloud Platform e instale las dependencias.

gcloud auth login
gcloud auth application-default login
gcloud config set project < project name > 

python3 -m venv venv
source ./venv/bin/activate
pip install -r requirements.txt

Uso

Para ejecutar un simple fragmento de código, puede hacer lo siguiente:

• Importar una clase desde dfcx_scrapi.core
• Asigne su cuenta de servicio a una variable local

 from dfcx_scrapi . core . intents import Intents

creds_path = '<PATH_TO_YOUR_SERVICE_ACCOUNT_JSON_FILE>'
agent_path = '<FULL_DFCX_AGENT_ID_PATH>'

# DFCX Agent ID paths are in this format:
# 'projects/<project_id>/locations/<location_id>/agents/<agent_id>'

# Instantiate your class object and pass in your credentials
i = Intents ( creds_path , agent_id = agent_path )

# Retrieve all Intents and Training Phrases from an Agent and push to a Pandas DataFrame
df = i . bulk_intent_to_df ()

Composición de la biblioteca

A continuación se ofrece una breve descripción general de la estructura de la biblioteca SCRAPI y la motivación detrás de esa estructura.

Centro

La carpeta principal es sinónimo de los tipos de recursos principales en los agentes DFCX (agentes, intenciones, flujos, etc.)

• Esta carpeta contiene los componentes básicos de alto nivel de SCRAPI.
• Estas clases y métodos se pueden utilizar para crear métodos de nivel superior o herramientas y aplicaciones personalizadas.

Herramientas

La carpeta Herramientas contiene varios kits de herramientas personalizados que le permiten realizar tareas de administración de bots más complejas, como

• Manipular los tipos de recursos del agente en varias estructuras de DataFrame
• Copiar recursos de agentes entre agentes y proyectos de GCP en un recurso por nivel de recurso
• Mueva datos hacia y desde DFCX y otros servicios de GCP como BigQuery, Sheets, etc.
• Cree consultas de búsqueda personalizadas dentro de los recursos de su agente

Constructores

La carpeta Builders contiene métodos simples para construir los protos subyacentes en Dialogflow CX.

• Los protoobjetos son los componentes fundamentales de Dialogflow CX
• Las clases de creación permiten al usuario construir recursos de Dialogflow CX sin conexión sin ninguna llamada API.
• Una vez que se construyen los componentes de recursos, se pueden enviar a un agente de Dialogflow CX en vivo a través de API.

Contribuyendo

¡Agradecemos cualquier contribución o solicitud de funciones que desee enviar!

1. Bifurcar el proyecto
2. Cree su rama de funciones (git checkout -b feature/AmazingFeature)
3. Confirme sus cambios (git commit -m 'Agregar alguna característica increíble')
4. Push to the Branch (función de origen de git push/AmazingFeature)
5. Abrir una solicitud de extracción

Licencia

Distribuido bajo la Licencia Apache 2.0. Consulte LICENCIA para obtener más información.

Contacto

Patrick Marlow - [email protected] - @kmaphoenix
Milad Tabrizi - [email protected] - @MRyderOC

Enlace del proyecto: https://github.com/GoogleCloudPlatform/dfcx-scrapi

Expresiones de gratitud

Biblioteca cliente de Python de Dialogflow CX
Abrazando la cara - Paráfrasis de Pegaso