dfcx scrapi下載 - dfcx scrapi原始碼下載

dfcx scrapi

Ai源碼

v1.12.5

下載

Python Dialogflow CX 腳本 API (SCRAPI)

面向機器人建構者、開發者和維護者的高階腳本 API。

介紹
- 我可以用 SCRAPI 做什麼？
- 內建
入門
- 環境設定
- 驗證
用法
文庫組成
- 核
- 工具
貢獻
執照
接觸
致謝

介紹

Python Dialogflow CX 腳本 API (DFCX SCRAPI) 是一個進階 API，擴展了 Dialogflow CX 的官方 Google Python 用戶端。對於機器人建構者、開發者和維護者來說，SCRAPI 讓 DFCX 的使用變得更容易、更友善、更 Pythonic。

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

我可以用 DFCX SCRAPI 做什麼？

透過 DFCX SCRAPI，您可以大規模執行許多機器人建置和維護操作，包括但不限於：

建立、更新、刪除、取得和列出所有 CX 資源類型（即意圖、實體類型、頁面、串流等）
將常用的 CX 資源轉換為 Pandas 資料幀
與 CX 代理進行全自動對話（對於回歸測試非常有用！）
提取驗證訊息
提取變更歷史資訊
使用 Search Util 函數搜尋所有串流/頁面/路由以尋找特定參數或話語
使用 Copy Util 功能在座席之間快速移動 CX 資源！
使用 Builder 方法建構 CX 用於每種資源類型的基本 protobuf 對象
……還有更多、更多！

內建

Python 3.8+

驗證

身份驗證可能會有所不同，具體取決於您與 SCRAPI 互動的方式和位置。

Google合作實驗室

如果您將 SCRAPI 與 Google Colab 筆記本一起使用，您可以將以下內容新增至筆記本頂部以便於驗證：

 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

執行上述命令後，Colab 將從環境中取得您的憑證並將其直接傳遞給 SCRAPI。無需使用服務帳戶金鑰！然後您可以像這樣簡單地使用 SCRAPI：

 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 )

雲端功能/雲端運行

如果您將 SCRAPI 與 Cloud Functions 或 Cloud Run 結合使用，SCRAPI 可以取得這些服務使用的預設環境憑證，而無需任何其他配置！

將dfcx-scrapi加入您的requirements.txt檔案中
確保 Cloud Function/Cloud Run 服務帳戶具有適當的 Dialogflow IAM 角色

一旦完成上述設置，您的函數程式碼就可以像這樣輕鬆使用：

 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 )

本地Python環境

與 Cloud Functions / Cloud Run 類似，如果您使用 gcloud CLI，則 SCRAPI 可以取得您的本機驗證憑證。

安裝 gcloud CLI。
運行gcloud init 。
運行gcloud auth login
執行gcloud auth list以確保您的主要帳戶處於活動狀態。

這將使用 gcloud CLI 對您的主要 GCP 帳戶進行身份驗證，並且 SCRAPI 可以從此處取得憑證。

例外情況和雜項。

SCRAPI 中的一些類別仍然依賴服務帳戶金鑰，特別是 DataframeFunctions 類，因為它如何使用 Google Sheets 進行身份驗證。

為了使用這些功能，您需要一個對您的 GCP 項目具有適當存取權限的服務帳號。
有關更多資訊並查看服務帳戶的官方文檔，請前往建立和管理 GCP 服務帳戶。

取得具有適當權限的服務帳戶金鑰後，您可以按如下方式使用它：

 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 )

入門

環境設定

設定 Google Cloud Platform 憑證並安裝相依性。

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

用法

要執行一段簡單的程式碼，您可以執行以下操作：

從dfcx_scrapi.core導入類
將您的服務帳戶指派給本機變數

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