简介:如何在开发者平台上架百度OCR应用
百度云OCR
我们以百度云的开发者平台做一个应用开发示例,来讲解如何构建一个应用。从这篇示例中我们将了解:
如何设置Session Auth授权
如何设置一个执行动作
作为演示示例,我们将使用百度云的OCR图片转文字接口,构建一个 “百度云图片转文字”应用,并添加图片转文字执行动作,允许流程中使用此应用将图片网址中的图片内容包含的文字提取出来用于后续步骤使用。
百度云OCR产品介绍:https://cloud.baidu.com/product/ocr_general
百度云OCR接口文档:https://cloud.baidu.com/doc/OCR/s/zk3h7xz52

从百度云OCR授权接口文档:https://ai.baidu.com/ai-doc/REFERENCE/Ck3dwjhhu 中看到其是使用API Key和 Secrect换取Access_token的方式进行授权。因此我们在授权方式中选择 “Session Auth”

点击保存。
从文档中可以看到 百度云的授权需要用户填写自己的API Key 和 Secret Key,因此需要添加这两个字段。

点击设置授权字段步骤中的 ”添加字段”按钮,添加第一个需要用户输入的字段“API Key”

保存后,返回授权设置页面我们可以看到刚才配置的字段已经展现在授权字段设置中:

我们使用同样的方式,将另外一个需要用户填写的字段:Secret Key也设置好:

在这个步骤我们设置请求授权的接口信息。根据百度云的授权文档:https://ai.baidu.com/ai-doc/REFERENCE/Ck3dwjhhu
接口需要使用Post的方式,请求:https://aip.baidubce.com/oauth/2.0/token
填写的参数包括 client_id, client_secrect 和一个固定的参数:grant_type
我们将下面的参数配置在设置授权请求接口步骤

这个步骤类似于用户在使用集简云添加账号时的操作,用于校验授权验证接口是否可以正常使用。

点击下拉菜单,点击添加账号按钮,点击后出现添加账号弹窗,里面是设置的需要用户填写的授权字段(在3.1中设置的)

请您填写有效的授权信息后点击下一步。

在下拉列表中选择刚才添加的应用账号,然后点击授权测试:

在接口返回中,您可以看到授权返回的参数信息是否正确。如果正确,点击“结束测试并继续”按钮完成授权设置。
配置完成授权设置后,我们开始配置触发和执行动作,一个应用至少应该包括一个触发动作或者一个执行动作,您可以根据自己的业务需要创建多个触发与执行动作。
在本示例中,我们在“百度云图片转文字” 添加一个执行动作:”提取图片中的文字内容”
对应接口文档:https://cloud.baidu.com/doc/OCR/s/zk3h7xz52

动作设置中配置动作的基本信息,包含以下选项

配置完成后,点击 ”下一步“ 按钮
动作字段设置中配置需要用户在前端填写的字段信息,比如百度云这个示例中,根据接口文档https://cloud.baidu.com/doc/OCR/s/zk3h7xz52, 用户填写的字段包括:图片base64,图片URL, 识别语言类型等多个字段。
动作字段类型介绍
动作字段类型有3种:
注意:您可以将多个不同的动作字段类型混合使用,比如一个执行动作的接口中需要 3个普通字段,1个动态字段,2个字段组,您可以配置多个字段和不同的字段类型在一个动作设置中。
根据百度云OCR的接口文档:https://cloud.baidu.com/doc/OCR/s/zk3h7xz52, 其输入的第一个字段为 image:

这个是一个普通字段,文本类型,我们点击添加“普通字段”选项添加配置此字段:

点击后我们将文档中的一个字段:image 添加到动作字段设置中:

字段设置中包括下列选项:

[
{
“key”: “CHN_ENG”,
“label”: “中英文混合”
},
{
“key”: “ENG”,
“label”: “英文”
},
{
“key”: “JAP”,
“label”: “日文”
},
{
“key”: “KOR”,
“label”: “韩文”
}
]
配置完成第一个字段image后,点击保存。
参照上述示例,我们将百度云OCR接口中的其他字段配置好:

配置完成后再右侧有预览样式,此演示与用户在集简云配置此动作时的样式一样。方便您进行检查。
点击动作配置中的 ”动作接口参数设置”标签,进入接口参数设置页面,在这个界面我们将配置调用接口时需要需要的参数。

根据百度云OCR文档:https://cloud.baidu.com/doc/OCR/s/zk3h7xz52

我们设置请求地址和方式:
根据文档,我们设置请求方式为POST 请求地址为:https://aip.baidubce.com/rest/2.0/ocr/v1/general_basic

然后点击“更多选项”
会展开传入参数列表,在这里可以配置参数,header, body 等接口参数。
根据文档,在URL参数中需要输入 access_token,并使用接口授权中获取的参数。
我们在步骤 3.4 中请求参数返回中可以看到 返回内容中的token写在了”access_token” 这个字段内:

我们使用这个返回的字段key作为变量:

我们将文档中要求的参数:access_token写在请求参数中,后面插入授权变量,格式为 {{auth_data.授权接口返回内容中的字段key}}
3.4步骤中授权接口返回的内容中包含token的字段key为 “access_token” 因此,我们这里写入的变量为:{{auth_data.access_token}}
配置完成 请求参数后,我们点击”HTTP Header”页签:

根据文档,我们添加header要求的内容:
Content-Type: application/x-www-form-urlencoded
完成Header设置后,我们点击”请求body” 内容,根据文档,我们添加body请求内容:

前面为文档中要求请求的字段key,后面插入对应字段key中用户输入的变量,变量格式为:
{{input_data.动作字段设置中的字段key}}
额外选项可以控制如果用户没有填写字段时,是否忽略此字段的传参,我们建议保持默认的开启状态。

开启状态下,如果用户没有填字段,则发送时会默认不传入这个字段到接口,如果不开启则会传空值。例如:
Key1, Key2两个字段,如果用户只填写了Key1,没有填写Key2。
在接口请求测试中,您可以测试接口是否可以正常请求并返回参数。

在账户选择栏选择账户,这里会调用我们在步骤3.3授权测试时添加的账户信息
填写要的请求参数,然后点击 ”执行动作测试“按钮, 点击后可以在”接口返回”中看到返回参数

在”HTTP”中可以看到请求发送的内容:

在这个步骤您可以返回内容中字段Key对应的中文含有,和字段的解释说明,这里的配置将会展现在用户前端,便于用户理解接口返回内容。

样式:
配置后点击保存
配置完成并保存后,您可以在您企业的集简云账户下直接使用,应用默认只在您的企业下可见。

您可以使用这个应用配置流程。
如果您希望集简云的全部企业都可以使用您的应用,您需要进行全网发布。请在开发者平台菜单中点击:“应用管理/应用发布”菜单,里面有我们的发布流程和联系方式,请扫描二维码与我们的员工沟通发布适用,我们的市场运营同事也会配合做宣传活动。
