machinebox

type CheckFaceprintRequest struct {
	// Faceprints is a list of Faceprints to check.
	Faceprints []string
}

type CheckFaceprintResponse struct {
	// Faces is a list of faces checked from Faceprints.
	Faces []FaceprintFace
}

type CheckFileRequest struct {
	// File is the image to check for faces.
	File remototypes.File
}

type CheckFileResponse struct {
	// Faces is a list of faces that were found.
	Faces []Face
}

type CheckURLRequest struct {
	// URL is the address of the image to check.
	URL string
}

type CheckURLResponse struct {
	// Faces is a list of faces that were found.
	Faces []Face
}

type Face struct {
	// ID is the identifier of the source that was matched.
	ID string
	// Name is the name of the identified person.
	Name string
	// Matched is whether the face was recognized or not.
	Matched bool
	// Faceprint is the Facebox Faceprint of this face.
	Faceprint string
	// Rect is where the face appears in the source image.
	Rect Rect
}

type Facebox interface {

	// TeachFile teaches Facebox a new face from an image file.
	TeachFile(TeachFileRequest) TeachFileResponse

	// TeachURL teaches Facebox a new face from an image on the web.
	TeachURL(TeachURLRequest) TeachURLResponse

	// TeachFaceprint teaches Facebox about a face from a Faceprint.
	TeachFaceprint(TeachFaceprintRequest) TeachFaceprintResponse

	// CheckFile checks an image file for faces.
	CheckFile(CheckFileRequest) CheckFileResponse

	// CheckURL checks a hosted image file for faces.
	CheckURL(CheckURLRequest) CheckURLResponse

	// CheckFaceprint checks to see if a Faceprint matches any known
	// faces.
	CheckFaceprint(CheckFaceprintRequest) CheckFaceprintResponse

	// SimilarID checks for similar faces by ID.
	SimilarID(SimilarIDRequest) SimilarIDResponse

	// SimilarFile checks for similar faces from the face in an image file.
	SimilarFile(SimilarFileRequest) SimilarFileResponse

	// SimilarURL checks for similar faces in a hosted image file.
	SimilarURL(SimilarURLRequest) SimilarURLResponse

	// Rename changes a person's name.
	Rename(RenameRequest) RenameResponse

	// RenameID changes the name of a previously taught face, by ID.
	RenameID(RenameIDRequest) RenameIDResponse

	// RemoveID removes a face with the specified ID.
	RemoveID(RemoveIDRequest) RemoveIDResponse

	// FaceprintCompare compares faceprints to a specified target describing
	// similarity.
	FaceprintCompare(FaceprintCompareRequest) FaceprintCompareResponse

	// GetState gets the Facebox state file.
	GetState(GetStateRequest) remototypes.FileResponse

	// PutState sets the Facebox state file.
	PutState(PutStateRequest) PutStateResponse
}

type FaceprintCompareRequest struct {
	// Target is the target Faceprint to which the Faceprints will be compared.
	Target string
	// Faceprints is a list of Faceprints that will be compared to Target.
	Faceprints []string
}

type FaceprintCompareResponse struct {
	// Confidences is a list of confidence values.
	// The order matches the order of FaceprintCompareRequest.Faceprints.
	Confidences []float64
}

type FaceprintFace struct {
	// Matched is whether the face was recognized or not.
	Matched bool
	// Confidence is a numerical value of how confident the AI
	// is that this is a match.
	Confidence float64
	// ID is the identifier of the source that matched.
	ID string
	// Name is the name of the person recognized.
	Name string
}

type GetStateRequest struct{}

type PutStateRequest struct {
	// StateFile is the Facebox state file to set.
	StateFile remototypes.File
}

type PutStateResponse struct{}

type Rect struct {
	// Top is the starting Y coordinate.
	Top int
	// Left is the starting X coordinate.
	Left int
	// Width is the width.
	Width int
	// Height is the height.
	Height int
}

type RemoveIDRequest struct {
	// ID is the identifier of the source to remove.
	ID string
}

type RemoveIDResponse struct{}

type RenameIDRequest struct {
	// ID is the identifier of the source to rename.
	ID string
	// Name is the new name to assign to the item matching ID.
	Name string
}

type RenameIDResponse struct{}

type RenameRequest struct {
	// From is the original name.
	From string
	// To is the new name.
	To string
}

type RenameResponse struct{}

type SimilarFace struct {
	// Rect is where the face appears in the image.
	Rect Rect
	// SimilarFaces is a list of similar faces.
	SimilarFaces []Face
}

type SimilarFileRequest struct {
	File remototypes.File
}

type SimilarFileResponse struct {
	Faces []SimilarFace
}

type SimilarIDRequest struct {
	// ID is the identifier of the source to look for similar faces of.
	ID string
}

type SimilarIDResponse struct {
	// Faces is a list of similar faces.
	Faces []SimilarFace
}

type SimilarURLRequest struct {
	URL string
}

type SimilarURLResponse struct {
	Faces []SimilarFace
}

type TeachFaceprintRequest struct {
	ID        string
	Name      string
	Faceprint string
}

type TeachFaceprintResponse struct{}

type TeachFileRequest struct {
	// ID is an identifier describing the source, for example the filename.
	ID string
	// Name is the name of the person in the image.
	Name string
	// File is the image containing the face to teach.
	File remototypes.File
}

type TeachFileResponse struct{}

type TeachURLRequest struct {
	// ID is an identifier describing the source, for example the filename.
	ID string
	// Name is the name of the person in the image.
	Name string
	// URL is the address of the image.
	URL string
}

type TeachURLResponse struct{}