dfcx scrapi

API Skrip CX Dialogflow Python (SCRAPI)

API skrip tingkat tinggi untuk pembuat, pengembang, dan pengelola bot.

Daftar isi

1. Perkenalan
   • Apa yang Dapat Saya Lakukan dengan SCRAPI?
   • Dibangun Dengan
2. Memulai
   • Pengaturan Lingkungan
   • Otentikasi
3. Penggunaan
4. Komposisi Perpustakaan
   • Inti
   • Peralatan
5. Berkontribusi
6. Lisensi
7. Kontak
8. Ucapan Terima Kasih

Perkenalan

API Skrip Python Dialogflow CX (DFCX SCRAPI) adalah API tingkat tinggi yang memperluas Klien Google Python resmi untuk Dialogflow CX. SCRAPI menjadikan penggunaan DFCX lebih mudah, ramah, dan pythonic bagi pembuat, pengembang, dan pengelola bot.

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

Apa yang Dapat Saya Lakukan Dengan DFCX SCRAPI?

Dengan DFCX SCRAPI Anda dapat melakukan banyak tindakan pembuatan dan pemeliharaan bot dalam skala besar termasuk, namun tidak terbatas pada:

• Buat, Perbarui, Hapus, Dapatkan, dan Daftar untuk semua tipe sumber daya CX (yaitu Intent, Tipe Entitas, Halaman, Alur, dll.)
• Konversikan Sumber Daya CX yang umum diakses ke Pandas Dataframes
• Lakukan percakapan yang sepenuhnya otomatis dengan agen CX (berguna untuk pengujian regresi!)
• Ekstrak informasi Validasi
• Ekstrak informasi Riwayat Perubahan
• Telusuri seluruh Alur/Halaman/Rute untuk menemukan parameter atau ucapan tertentu menggunakan fungsi Search Util
• Pindahkan sumber daya CX antar agen dengan cepat menggunakan fungsi Copy Util!
• Bangun objek protobuf dasar yang digunakan CX untuk setiap jenis sumber daya menggunakan metode Builder
• ...dan masih banyak lagi!

Dibangun Dengan

• Python 3.8+

Otentikasi

Otentikasi dapat bervariasi tergantung pada bagaimana dan di mana Anda berinteraksi dengan SCRAPI.

Google Kolab

Jika Anda menggunakan SCRAPI dengan notebook Google Colab, Anda dapat menambahkan yang berikut ke bagian atas notebook Anda untuk memudahkan autentikasi:

 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

Setelah menjalankan langkah di atas, Colab akan mengambil kredensial Anda dari lingkungan dan meneruskannya ke SCRAPI secara langsung. Tidak perlu menggunakan kunci Akun Layanan! Anda kemudian dapat menggunakan SCRAPI seperti ini:

 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 )

---

Fungsi Cloud / Cloud Run

Jika Anda menggunakan SCRAPI dengan Cloud Functions atau Cloud Run, SCRAPI dapat mengambil kredit lingkungan default yang digunakan oleh layanan ini tanpa konfigurasi tambahan apa pun!

1. Tambahkan dfcx-scrapi ke file requirements.txt Anda
2. Pastikan akun layanan Cloud Function/Cloud Run memiliki IAM Role Dialogflow yang sesuai

Setelah Anda mengaturnya dengan hal di atas, kode fungsi Anda dapat digunakan dengan mudah seperti ini:

 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 )

---

Lingkungan Python Lokal

Mirip dengan Cloud Functions/Cloud Run, SCRAPI dapat mengambil kredibilitas autentikasi lokal Anda jika Anda menggunakan gcloud CLI.

1. Instal gcloud CLI.
2. Jalankan gcloud init .
3. Jalankan gcloud auth login
4. Jalankan gcloud auth list untuk memastikan akun utama Anda aktif.

Ini akan mengautentikasi akun GCP utama Anda dengan gcloud CLI, dan SCRAPI dapat mengambil kredibilitasnya dari sini.

---

Pengecualian dan Lain-lain.

Ada beberapa kelas di SCRAPI yang masih mengandalkan Kunci Akun Layanan, terutama kelas DataframeFunctions karena cara autentikasinya dengan Google Spreadsheet.

Untuk menggunakan fungsi ini, Anda memerlukan Akun Layanan yang memiliki akses yang sesuai ke project GCP Anda.
Untuk informasi selengkapnya dan melihat dokumentasi resmi akun layanan, buka Membuat dan Mengelola Akun Layanan GCP.

Setelah Anda mendapatkan Kunci Akun Layanan dengan izin yang sesuai, Anda dapat menggunakannya sebagai berikut:

 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 )

Memulai

Pengaturan Lingkungan

Siapkan kredensial Google Cloud Platform dan instal dependensi.

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

Penggunaan

Untuk menjalankan sedikit kode sederhana, Anda dapat melakukan hal berikut:

• Impor Kelas dari dfcx_scrapi.core
• Tetapkan Akun Layanan Anda ke variabel lokal

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

Komposisi Perpustakaan

Berikut adalah ikhtisar singkat struktur perpustakaan SCRAPI dan motivasi di balik struktur tersebut.

Inti

Folder Inti identik dengan tipe Sumber Daya inti di Agen DFCX (agen, maksud, alur, dll.)

• Folder ini berisi blok penyusun tingkat tinggi SCRAPI
• Kelas dan metode ini dapat digunakan untuk membangun metode tingkat yang lebih tinggi atau alat dan aplikasi khusus

Peralatan

Folder Alat berisi berbagai perangkat khusus yang memungkinkan Anda melakukan tugas manajemen bot yang lebih kompleks, seperti

• Memanipulasi tipe Sumber Daya Agen ke dalam berbagai struktur DataFrame
• Salin Sumber Daya Agen antara Agen dan Proyek GCP pada sumber daya berdasarkan tingkat sumber daya
• Memindahkan data ke dan dari DFCX serta Layanan GCP lainnya seperti BigQuery, Spreadsheet, dll.
• Buat kueri penelusuran yang disesuaikan di dalam sumber daya agen Anda

Pembangun

Folder Builders berisi metode sederhana untuk membuat proto yang mendasarinya di Dialogflow CX

• Objek proto adalah elemen dasar Dialogflow CX
• Kelas pembuat memungkinkan pengguna membuat sumber daya Dialogflow CX secara offline tanpa panggilan API apa pun
• Setelah komponen sumber daya dibuat, komponen tersebut kemudian dapat dikirim ke agen Dialogflow CX langsung melalui API

Berkontribusi

Kami menyambut setiap kontribusi atau permintaan fitur yang ingin Anda kirimkan!

1. Garpu Proyek
2. Buat Cabang Fitur Anda (git checkout -b feature/AmazingFeature)
3. Komit Perubahan Anda (git commit -m 'Tambahkan beberapa Fitur Luar Biasa')
4. Dorong ke Cabang (fitur asal git push/AmazingFeature)
5. Buka Permintaan Tarik

Lisensi

Didistribusikan di bawah Lisensi Apache 2.0. Lihat LISENSI untuk informasi lebih lanjut.

Kontak

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

Tautan Proyek: https://github.com/GoogleCloudPlatform/dfcx-scrapi

Ucapan Terima Kasih

Perpustakaan Klien Dialogflow CX Python
Memeluk Wajah - Parafrase Pegasus