machinebox

type CheckFaceprintRequest struct {

	// Faceprints is a list of Faceprints to check.
	Faceprints []string `json:"faceprints"`
}

type CheckFaceprintResponse struct {

	// Faces is a list of faces checked from Faceprints.
	Faces []FaceprintFace `json:"faces"`
	// Error is an error message if one occurred.
	Error string `json:"error"`
}

type CheckFileRequest struct {

	// File is the image to check for faces.
	File remototypes.File `json:"file"`
}

type CheckFileResponse struct {

	// Faces is a list of faces that were found.
	Faces []Face `json:"faces"`
	// Error is an error message if one occurred.
	Error string `json:"error"`
}

type CheckURLRequest struct {

	// URL is the address of the image to check.
	URL string `json:"url"`
}

type CheckURLResponse struct {

	// Faces is a list of faces that were found.
	Faces []Face `json:"faces"`
	// Error is an error message if one occurred.
	Error string `json:"error"`
}

type Face struct {

	// ID is the identifier of the source that was matched.
	ID string `json:"id"`
	// Name is the name of the identified person.
	Name string `json:"name"`
	// Matched is whether the face was recognized or not.
	Matched bool `json:"matched"`
	// Faceprint is the Facebox Faceprint of this face.
	Faceprint string `json:"faceprint"`
	// Rect is where the face appears in the source image.
	Rect Rect `json:"rect"`
}

type FaceboxClient struct {
	// contains filtered or unexported fields
}

type FaceprintCompareRequest struct {

	// Target is the target Faceprint to which the Faceprints will be compared.
	Target string `json:"target"`
	// Faceprints is a list of Faceprints that will be compared to Target.
	Faceprints []string `json:"faceprints"`
}

type FaceprintCompareResponse struct {

	// Confidences is a list of confidence values.
	// The order matches the order of FaceprintCompareRequest.Faceprints.
	Confidences []float64 `json:"confidences"`
	// Error is an error message if one occurred.
	Error string `json:"error"`
}

type FaceprintFace struct {

	// Matched is whether the face was recognized or not.
	Matched bool `json:"matched"`
	// Confidence is a numerical value of how confident the AI
	// is that this is a match.
	Confidence float64 `json:"confidence"`
	// ID is the identifier of the source that matched.
	ID string `json:"id"`
	// Name is the name of the person recognized.
	Name string `json:"name"`
}

type GetStateRequest struct {
}

type PutStateRequest struct {

	// StateFile is the Facebox state file to set.
	StateFile remototypes.File `json:"state_file"`
}

type PutStateResponse struct {

	// Error is an error message if one occurred.
	Error string `json:"error"`
}

type Rect struct {

	// Top is the starting Y coordinate.
	Top int `json:"top"`
	// Left is the starting X coordinate.
	Left int `json:"left"`
	// Width is the width.
	Width int `json:"width"`
	// Height is the height.
	Height int `json:"height"`
}

type RemoveIDRequest struct {

	// ID is the identifier of the source to remove.
	ID string `json:"id"`
}

type RemoveIDResponse struct {

	// Error is an error message if one occurred.
	Error string `json:"error"`
}

type RenameIDRequest struct {

	// ID is the identifier of the source to rename.
	ID string `json:"id"`
	// Name is the new name to assign to the item matching ID.
	Name string `json:"name"`
}

type RenameIDResponse struct {

	// Error is an error message if one occurred.
	Error string `json:"error"`
}

type RenameRequest struct {

	// From is the original name.
	From string `json:"from"`
	// To is the new name.
	To string `json:"to"`
}

type RenameResponse struct {

	// Error is an error message if one occurred.
	Error string `json:"error"`
}

type SimilarFace struct {

	// Rect is where the face appears in the image.
	Rect Rect `json:"rect"`
	// SimilarFaces is a list of similar faces.
	SimilarFaces []Face `json:"similar_faces"`
}

type SimilarFileRequest struct {
	File remototypes.File `json:"file"`
}

type SimilarFileResponse struct {
	Faces []SimilarFace `json:"faces"`
	// Error is an error message if one occurred.
	Error string `json:"error"`
}

type SimilarIDRequest struct {

	// ID is the identifier of the source to look for similar faces of.
	ID string `json:"id"`
}

type SimilarIDResponse struct {

	// Faces is a list of similar faces.
	Faces []SimilarFace `json:"faces"`
	// Error is an error message if one occurred.
	Error string `json:"error"`
}

type SimilarURLRequest struct {
	URL string `json:"url"`
}

type SimilarURLResponse struct {
	Faces []SimilarFace `json:"faces"`
	// Error is an error message if one occurred.
	Error string `json:"error"`
}

type TeachFaceprintRequest struct {
	ID        string `json:"id"`
	Name      string `json:"name"`
	Faceprint string `json:"faceprint"`
}

type TeachFaceprintResponse struct {

	// Error is an error message if one occurred.
	Error string `json:"error"`
}

type TeachFileRequest struct {

	// ID is an identifier describing the source, for example the filename.
	ID string `json:"id"`
	// Name is the name of the person in the image.
	Name string `json:"name"`
	// File is the image containing the face to teach.
	File remototypes.File `json:"file"`
}

type TeachFileResponse struct {

	// Error is an error message if one occurred.
	Error string `json:"error"`
}

type TeachURLRequest struct {

	// ID is an identifier describing the source, for example the filename.
	ID string `json:"id"`
	// Name is the name of the person in the image.
	Name string `json:"name"`
	// URL is the address of the image.
	URL string `json:"url"`
}

type TeachURLResponse struct {

	// Error is an error message if one occurred.
	Error string `json:"error"`
}