首页>编程相关>Ai源码
下载
Scrappy，SCRAPI 吉祥物！

Python Dialogflow CX 脚本 API (SCRAPI)

面向机器人构建者、开发者和维护者的高级脚本 API。

目录
  1. 介绍
    • 我可以用 SCRAPI 做什么？
    • 内置
  2. 入门
    • 环境设置
    • 验证
  3. 用法
  4. 文库组成
    • 核
    • 工具
  5. 贡献
  6. 执照
  7. 接触
  8. 致谢

介绍

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 交互的方式和位置。

谷歌合作实验室

如果您将 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 可以获取这些服务使用的默认环境凭据，而无需任何其他配置！

  1. 将dfcx-scrapi添加到您的requirements.txt文件中
  2. 确保 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 可以获取您的本地身份验证凭据。

  1. 安装 gcloud CLI。
  2. 运行gcloud init 。
  3. 运行gcloud auth login
  4. 运行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 ()

文库组成

以下是 SCRAPI 库的结构以及该结构背后的动机的简要概述。

核

Core 文件夹与 DFCX 代理中的核心资源类型（代理、意图、流等）同义。

  • 该文件夹包含 SCRAPI 的高级构建块
  • 这些类和方法可用于构建更高级别的方法或自定义工具和应用程序

工具

Tools 文件夹包含各种自定义工具包，可让您执行更复杂的机器人管理任务，例如

  • 将代理资源类型操纵为各种 DataFrame 结构
  • 按资源级别在资源上的代理和 GCP 项目之间复制代理资源
  • 将数据移入和移出 DFCX 和其他 GCP 服务（例如 BigQuery、表格等）。
  • 在代理资源内创建自定义搜索查询

建设者

Builders 文件夹包含用于在 Dialogflow CX 中构建底层原型的简单方法

  • Proto 对象是 Dialogflow CX 的基本构建块
  • 构建器类允许用户离线构建 Dialogflow CX 资源，无需任何 API 调用
  • 构建资源组件后，可以通过 API 将它们推送到实时 Dialogflow CX 代理

贡献

我们欢迎您提交任何贡献或功能请求！

  1. 分叉项目
  2. 创建您的功能分支（git checkout -b feature/AmazingFeature）
  3. 提交您的更改（git commit -m 'Add some AmazingFeature'）
  4. 推送到分支（git Push origin 功能/AmazingFeature）
  5. 打开拉取请求

执照

根据 Apache 2.0 许可证分发。请参阅许可证了解更多信息。

接触

帕特里克·马洛 - [email protected] - @kmaphoenix
米拉德·塔布里兹 - [email protected] - @MRyderOC

项目链接：https://github.com/GoogleCloudPlatform/dfcx-scrapi

致谢

Dialogflow CX Python 客户端库
拥抱脸 - 飞马座释义

展开
附加信息
相关应用
为您推荐
相关资讯 全部