Téléchargement du code source dfcx scrapi - Téléchargement du code source dfcx scrapi

dfcx scrapi

Code Source AI

v1.12.5

Télécharger

API de script Python Dialogflow CX (SCRAPI)

Une API de script de haut niveau pour les créateurs, les développeurs et les responsables de robots.

Table des matières

Introduction
- Que puis-je faire avec SCRAPI ?
- Construit avec
Commencer
- Configuration de l'environnement
- Authentification
Usage
Composition de la bibliothèque
- Cœur
- Outils
Contribuer
Licence
Contact
Remerciements

Introduction

L'API de script Python Dialogflow CX (DFCX SCRAPI) est une API de haut niveau qui étend le client Google Python officiel pour Dialogflow CX. SCRAPI rend l'utilisation de DFCX plus facile, plus conviviale et plus pythonique pour les constructeurs, développeurs et responsables de robots.

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

Que puis-je faire avec DFCX SCRAPI ?

Avec DFCX SCRAPI, vous pouvez effectuer de nombreuses actions de création et de maintenance de robots à grande échelle, notamment :

Créer, mettre à jour, supprimer, obtenir et répertorier tous les types de ressources CX (c'est-à-dire intentions, types d'entités, pages, flux, etc.)
Convertir les ressources CX couramment consultées en trames de données Pandas
Ayez des conversations entièrement automatisées avec un agent CX (puissant pour les tests de régression !)
Extraire les informations de validation
Extraire les informations de l'historique des modifications
Recherchez dans tous les flux/pages/itinéraires pour trouver un paramètre ou un énoncé spécifique à l'aide des fonctions Search Util.
Déplacez rapidement les ressources CX entre les agents à l'aide des fonctions Copy Util !
Créez les objets protobuf fondamentaux que CX utilise pour chaque type de ressource à l'aide des méthodes Builder
...et bien plus encore !

Construit avec

Python3.8+

Authentification

L'authentification peut varier en fonction de la manière et de l'endroit où vous interagissez avec SCRAPI.

Google Colab

Si vous utilisez SCRAPI avec un bloc-notes Google Colab, vous pouvez ajouter les éléments suivants en haut de votre bloc-notes pour une authentification facile :

 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

Après avoir exécuté ce qui précède, Colab récupérera vos informations d'identification dans l'environnement et les transmettra directement à SCRAPI. Pas besoin d'utiliser les clés du compte de service ! Vous pouvez ensuite utiliser SCRAPI simplement comme ceci :

 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 )

Fonctions Cloud/Cloud Run

Si vous utilisez SCRAPI avec Cloud Functions ou Cloud Run, SCRAPI peut récupérer les crédits d'environnement par défaut utilisés par ces services sans aucune configuration supplémentaire !

Ajoutez dfcx-scrapi à votre fichier requirements.txt
Assurez-vous que le compte de service Cloud Function/Cloud Run dispose du rôle IAM Dialogflow approprié.

Une fois que vous avez configuré ce qui précède, votre code de fonction peut être utilisé facilement comme ceci :

 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 )

Environnement Python local

Semblable à Cloud Functions/Cloud Run, SCRAPI peut récupérer vos identifiants d'authentification locaux si vous utilisez gcloud CLI.

Installez gcloud CLI.
Exécutez gcloud init .
Exécutez gcloud auth login
Exécutez gcloud auth list pour vous assurer que votre compte principal est actif.

Cela authentifiera votre compte GCP principal avec gcloud CLI, et SCRAPI pourra récupérer les crédits à partir d'ici.

Exceptions et divers.

Certaines classes de SCRAPI reposent toujours sur des clés de compte de service, notamment la classe DataframeFunctions en raison de la manière dont elle s'authentifie auprès de Google Sheets.

Pour utiliser ces fonctions, vous aurez besoin d'un compte de service disposant d'un accès approprié à votre projet GCP.
Pour plus d'informations et pour consulter la documentation officielle sur les comptes de service, accédez à Création et gestion des comptes de service GCP.

Une fois que vous avez obtenu une clé de compte de service avec les autorisations appropriées, vous pouvez l'utiliser comme suit :

 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 )

Commencer

Configuration de l'environnement

Configurez les informations d'identification Google Cloud Platform et installez les dépendances.

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

Usage

Pour exécuter un simple morceau de code, vous pouvez procéder comme suit :

Importer une classe depuis dfcx_scrapi.core
Attribuez votre compte de service à une variable locale

 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 ()

Composition de la bibliothèque

Voici un bref aperçu de la structure de la bibliothèque SCRAPI et de la motivation derrière cette structure.

Cœur

Le dossier Core est synonyme des types de ressources de base dans les agents DFCX (agents, intentions, flux, etc.)

Ce dossier contient les éléments de base de haut niveau de SCRAPI
Ces classes et méthodes peuvent être utilisées pour créer des méthodes de niveau supérieur ou des outils et applications personnalisés.

Outils

Le dossier Outils contient diverses boîtes à outils personnalisées qui vous permettent d'effectuer des tâches de gestion de robots plus complexes, telles que

Manipuler les types de ressources d'agent dans diverses structures DataFrame
Copier les ressources d'agent entre les agents et les projets GCP sur une ressource par niveau de ressource
Déplacez des données vers et depuis DFCX et d'autres services GCP tels que BigQuery, Sheets, etc.
Créez des requêtes de recherche personnalisées dans les ressources de vos agents

Constructeurs

Le dossier Builders contient des méthodes simples pour construire les protos sous-jacents dans Dialogflow CX

Les objets Proto sont les éléments fondamentaux de Dialogflow CX
Les classes Builder permettent à l'utilisateur de créer une ressource Dialogflow CX hors ligne sans aucun appel d'API.
Une fois les composants de ressources construits, ils peuvent ensuite être transférés vers un agent Dialogflow CX en direct via l'API.