dfcx scrapi

API de script Python Dialogflow CX (SCRAPI)

Uma API de script de alto nível para criadores, desenvolvedores e mantenedores de bots.

Índice

1. Introdução
   • O que posso fazer com SCRAPI?
   • Construído com
2. Começando
   • Configuração do ambiente
   • Autenticação
3. Uso
4. Composição da Biblioteca
   • Essencial
   • Ferramentas
5. Contribuindo
6. Licença
7. Contato
8. Agradecimentos

Introdução

A API de script Python Dialogflow CX (DFCX SCRAPI) é uma API de alto nível que estende o cliente oficial do Google Python para Dialogflow CX. SCRAPI torna o uso do DFCX mais fácil, mais amigável e mais python para construtores, desenvolvedores e mantenedores de bots.

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

O que posso fazer com DFCX SCRAPI?

Com o DFCX SCRAPI você pode realizar muitas ações de construção e manutenção de bots em escala, incluindo, mas não se limitando a:

• Crie, atualize, exclua, obtenha e liste todos os tipos de recursos CX (ou seja, intenções, tipos de entidade, páginas, fluxos, etc.)
• Converta recursos CX comumente acessados ​​em Dataframes Pandas
• Tenha conversas totalmente automatizadas com um agente CX (poderoso para testes de regressão!)
• Extrair informações de validação
• Extraia informações do histórico de alterações
• Pesquise todos os fluxos/páginas/rotas para encontrar um parâmetro ou expressão específica usando as funções do Search Util
• Mova rapidamente recursos CX entre agentes usando as funções do Copy Util!
• Crie os objetos protobuf fundamentais que o CX usa para cada tipo de recurso usando métodos Builder
• ...e muito, muito mais!

Construído com

• Python 3.8+

Autenticação

A autenticação pode variar dependendo de como e onde você está interagindo com o SCRAPI.

Google Colab

Se estiver usando SCRAPI com um notebook Google Colab, você pode adicionar o seguinte na parte superior do notebook para facilitar a autenticação:

 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

Depois de executar o procedimento acima, o Colab irá coletar suas credenciais do ambiente e passá-las diretamente para o SCRAPI. Não há necessidade de usar chaves de conta de serviço! Você pode então usar SCRAPI simplesmente assim:

 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 )

---

Funções de nuvem/Cloud Run

Se você estiver usando SCRAPI com Cloud Functions ou Cloud Run, a SCRAPI poderá selecionar as credenciais de ambiente padrão usadas por esses serviços sem nenhuma configuração adicional.

1. Adicione dfcx-scrapi ao seu arquivo requirements.txt
2. Verifique se a conta de serviço do Cloud Function/Cloud Run tem o papel apropriado do IAM do Dialogflow

Depois de configurar o acima, seu código de função pode ser usado facilmente assim:

 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 )

---

Ambiente Python local

Semelhante ao Cloud Functions/Cloud Run, o SCRAPI pode detectar suas credenciais de autenticação local se você estiver usando a CLI gcloud.

1. Instale a CLI gcloud.
2. Execute gcloud init .
3. Execute gcloud auth login
4. Execute gcloud auth list para garantir que sua conta principal esteja ativa.

Isso autenticará sua conta principal do GCP com a CLI gcloud, e a SCRAPI poderá obter as credenciais aqui.

---

Exceções e Misc.

Existem algumas classes no SCRAPI que ainda dependem de chaves de conta de serviço, principalmente a classe DataframeFunctions devido à forma como ela é autenticada no Planilhas Google.

Para usar essas funções, você precisará de uma conta de serviço com acesso adequado ao seu projeto do GCP.
Para obter mais informações e visualizar a documentação oficial das contas de serviço, acesse Criação e gerenciamento de contas de serviço do GCP.

Depois de obter uma chave de conta de serviço com as permissões apropriadas, você poderá usá-la da seguinte maneira:

 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 )

Começando

Configuração do ambiente

Configure as credenciais do Google Cloud Platform e instale dependências.

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 executar um código simples, você pode fazer o seguinte:

• Importe uma classe de dfcx_scrapi.core
• Atribua sua conta de serviço a uma variável 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 ()

Composição da Biblioteca

Aqui está uma breve visão geral da estrutura da biblioteca SCRAPI e a motivação por trás dessa estrutura.

Essencial

A pasta Core é sinônimo dos principais tipos de recursos nos Agentes DFCX (agentes, intenções, fluxos, etc.)

• Esta pasta contém os blocos de construção de alto nível do SCRAPI
• Essas classes e métodos podem ser usados ​​para construir métodos de nível superior ou ferramentas e aplicativos personalizados

Ferramentas

A pasta Ferramentas contém vários kits de ferramentas personalizados que permitem realizar tarefas mais complexas de gerenciamento de bot, como

• Manipular tipos de recursos de agente em várias estruturas DataFrame
• Copiar recursos de agente entre agentes e projetos do GCP em um recurso por nível de recurso
• Mova dados de e para DFCX e outros serviços do GCP, como BigQuery, Sheets, etc.
• Crie consultas de pesquisa personalizadas dentro dos recursos do seu agente

Construtores

A pasta Builders contém métodos simples para construir os protos subjacentes no Dialogflow CX

• Objetos proto são os blocos de construção fundamentais do Dialogflow CX
• As classes Builder permitem que o usuário construa recursos do Dialogflow CX off-line sem nenhuma chamada de API
• Depois que os componentes de recursos são construídos, eles podem ser enviados para um agente Dialogflow CX ativo por meio de API

Contribuindo

Agradecemos quaisquer contribuições ou solicitações de recursos que você gostaria de enviar!

1. Bifurque o projeto
2. Crie sua ramificação de recursos (git checkout -b feature/AmazingFeature)
3. Confirme suas alterações (git commit -m 'Add some AmazingFeature')
4. Push to the Branch (recurso de origem git push/AmazingFeature)
5. Abra uma solicitação pull

Licença

Distribuído sob a licença Apache 2.0. Consulte LICENÇA para obter mais informações.

Contato

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

Link do projeto: https://github.com/GoogleCloudPlatform/dfcx-scrapi

Agradecimentos

Biblioteca de cliente Python do Dialogflow CX
Abraçando o Rosto – Paráfrase de Pégaso