class OxfordFaceApi::PersonGroup
Public Class Methods
new()
click to toggle source
# File lib/oxford/face/api.rb, line 222 def initialize raise if OxfordFaceApi.API_KEY.empty? @client = HttpClient.new(OxfordFaceApi.API_KEY) end
Public Instance Methods
all(start = 1, top = 1000)
click to toggle source
List Person
Groups GET api.projectoxford.ai/face/v1.0/persongroups[?start][&top]
# File lib/oxford/face/api.rb, line 258 def all(start = 1, top = 1000) @client.get("/persongroups?start=#{start}&top=#{top}") end
create(group_id, name, user_data = "")
click to toggle source
Create a Person
Group PUT api.projectoxford.ai/face/v1.0/persongroups/{personGroupId}
# File lib/oxford/face/api.rb, line 229 def create(group_id, name, user_data = "") params = { name: name, userData: user_data } @client.put("/persongroups/#{group_id}", params) end
delete(group_id)
click to toggle source
FIXME Delete a Person
Group DELETE api.projectoxford.ai/face/v1.0/persongroups/{personGroupId}
# File lib/oxford/face/api.rb, line 240 def delete(group_id) @client.delete("/persongroups/#{group_id}") end
get(group_id)
click to toggle source
Get a Person
Group GET api.projectoxford.ai/face/v1.0/persongroups/{personGroupId}
# File lib/oxford/face/api.rb, line 246 def get(group_id) @client.get("/persongroups/#{group_id}") end
status(group_id)
click to toggle source
Get Person
Group Training Status GET api.projectoxford.ai/face/v1.0/persongroups/{personGroupId}/training
# File lib/oxford/face/api.rb, line 252 def status(group_id) @client.get("/persongroups/#{group_id}/training") end
train(group_id)
click to toggle source
Train Person
Group POST api.projectoxford.ai/face/v1.0/persongroups/{personGroupId}/train
# File lib/oxford/face/api.rb, line 264 def train(group_id) @client.post("/persongroups/#{group_id}/train") end
update(group_id, name, user_data)
click to toggle source
Update a Person
Group PATCH api.projectoxford.ai/face/v1.0/persongroups/{personGroupId}
# File lib/oxford/face/api.rb, line 270 def update(group_id, name, user_data) params = { name: name, userData: user_data } @client.patch("/persongroups/#{group_id}", params) end