class OxfordFaceApi::FaceList

Public Class Methods

new() click to toggle source
# File lib/oxford/face/api.rb, line 83
def initialize
  raise if OxfordFaceApi.API_KEY.empty?
  @client = HttpClient.new(OxfordFaceApi.API_KEY)
end

Public Instance Methods

add_face(face_list_id, url, user_data = "", target_face = "") click to toggle source

Add a Face to a Face List POST api.projectoxford.ai/face/v1.0/facelists/{faceListId}/persistedFaces[?userData][&targetFace]

# File lib/oxford/face/api.rb, line 90
def add_face(face_list_id, url, user_data = "", target_face = "")
  params = {
        url: url
  }
  @client.post("/facelists/#{face_list_id}/persistedFaces?userData=#{user_data}&targetFace=#{target_face}", params)
end
all() click to toggle source

List Face Lists GET api.projectoxford.ai/face/v1.0/facelists

# File lib/oxford/face/api.rb, line 129
def all
  @client.get("/facelists")
end
create(face_list_id, name, user_data = "") click to toggle source

Create a Face List PUT api.projectoxford.ai/face/v1.0/facelists/{faceListId}

# File lib/oxford/face/api.rb, line 99
def create(face_list_id, name, user_data = "")
  params = {
        name: name,
        userData: user_data
  }
  @client.put("/facelists/#{face_list_id}", params)
end
delete(face_list_id) click to toggle source

FIXME Delete a Face List DELETE api.projectoxford.ai/face/v1.0/facelists/{faceListId}

# File lib/oxford/face/api.rb, line 117
def delete(face_list_id)
  @client.delete("/facelists/#{face_list_id}")
end
delete_face(face_list_id, face_id) click to toggle source

FIXME Delete a Face from a Face List DELETE api.projectoxford.ai/face/v1.0/facelists/{faceListId}/persistedFaces/{persistedFaceId}

# File lib/oxford/face/api.rb, line 110
def delete_face(face_list_id, face_id)
  @client.delete("/facelists/#{face_list_id}/persistedFaces/#{face_id}")
end
faces(face_list_id) click to toggle source

Get a Face List GET api.projectoxford.ai/face/v1.0/facelists/{faceListId}

# File lib/oxford/face/api.rb, line 123
def faces(face_list_id)
  @client.get("/facelists/#{face_list_id}")
end
update(face_list_id, name, user_data) click to toggle source

Update a Face List PATCH api.projectoxford.ai/face/v1.0/facelists/{faceListId}

# File lib/oxford/face/api.rb, line 135
def update(face_list_id, name, user_data)
  params = {
        name: name,
        userData: user_data
  }
  @client.patch("/facelists/#{face_list_id}", params)
end