Face Ruby 库使用文档

1. 安装指南

在开始使用Face Ruby库之前，需要先确保您的系统中已经安装了Ruby环境。安装完成后，可以通过以下命令安装Face库：

sudo gem install face

确保在执行安装命令时您有足够的权限，否则可能会遇到权限问题。

2. 项目使用说明

Face Ruby库是基于SkyBiometry的人脸检测与识别API构建的。以下是如何使用这个库的基本步骤：

首先，您需要在Ruby交互式环境(irb)或者您的Ruby脚本中引入这个库：

require 'face'

接下来，创建一个客户端实例，并使用您的API密钥初始化它：

client = Face.get_client(api_key: 'your_api_key', api_secret: 'your_api_secret')

请替换 'your_api_key' 和 'your_api_secret' 为您从SkyBiometry获取的API密钥和密钥。

检测网络图片中的人脸

使用图片URL来检测人脸：

client.faces_detect(urls: ['http://farm6.static.flickr.com/5220/5431220348_fbdf80ae9.jpg'])

获取所有的人脸属性

如果您想获取检测到的每个脸的详细信息，可以像下面这样传递attributes: 'all'参数：

client.faces_detect(urls: ['http://farm6.static.flickr.com/5220/5431220348_fbdf80ae9.jpg'], attributes: 'all')

检测本地图片文件中的人脸

如果您有一个本地的图片文件，也想进行人脸检测，可以使用file参数：

client.faces_detect(file: File.new('image.jpg', 'rb'))

请确保传递的是一个有效的文件对象，且文件路径正确。

3. 项目API使用文档

Face Ruby库提供的API使用方法和参数如下：

• Face.get_client(api_key:, api_secret:): 创建并返回一个客户端实例。
• client.faces_detect(urls: [], attributes: nil, file: nil): 检测传入的URL或文件中的人脸。其中urls参数是一个包含图片URL的数组，attributes参数是一个字符串，指定需要获取的属性，file参数是一个指向图片文件的文件对象。

4. 项目安装方式

如前所述，项目的安装方式是通过Ruby的gem包管理工具进行。具体命令如下：

sudo gem install face

以上就是关于Face Ruby库的安装和使用说明。如果您在使用过程中遇到任何问题，请参照库的README文件中的提示创建issues。