faceapi

Documentation

Index

• type ClientAPI
• type LargeFaceListClientAPI
• type LargePersonGroupClientAPI
• type LargePersonGroupPersonClientAPI
• type ListClientAPI
• type PersonGroupClientAPI
• type PersonGroupPersonClientAPI
• type SnapshotClientAPI

Types

type ClientAPI

type ClientAPI interface {
	DetectWithStream(ctx context.Context, imageParameter io.ReadCloser, returnFaceID *bool, returnFaceLandmarks *bool, returnFaceAttributes []face.AttributeType) (result face.ListDetectedFace, err error)
	DetectWithURL(ctx context.Context, imageURL face.ImageURL, returnFaceID *bool, returnFaceLandmarks *bool, returnFaceAttributes []face.AttributeType) (result face.ListDetectedFace, err error)
	FindSimilar(ctx context.Context, body face.FindSimilarRequest) (result face.ListSimilarFace, err error)
	Group(ctx context.Context, body face.GroupRequest) (result face.GroupResult, err error)
	Identify(ctx context.Context, body face.IdentifyRequest) (result face.ListIdentifyResult, err error)
	VerifyFaceToFace(ctx context.Context, body face.VerifyFaceToFaceRequest) (result face.VerifyResult, err error)
	VerifyFaceToPerson(ctx context.Context, body face.VerifyFaceToPersonRequest) (result face.VerifyResult, err error)
}

ClientAPI contains the set of methods on the Client type.

type LargeFaceListClientAPI

type LargeFaceListClientAPI interface {
	AddFaceFromStream(ctx context.Context, largeFaceListID string, imageParameter io.ReadCloser, userData string, targetFace []int32) (result face.PersistedFace, err error)
	AddFaceFromURL(ctx context.Context, largeFaceListID string, imageURL face.ImageURL, userData string, targetFace []int32) (result face.PersistedFace, err error)
	Create(ctx context.Context, largeFaceListID string, body face.NameAndUserDataContract) (result autorest.Response, err error)
	Delete(ctx context.Context, largeFaceListID string) (result autorest.Response, err error)
	DeleteFace(ctx context.Context, largeFaceListID string, persistedFaceID uuid.UUID) (result autorest.Response, err error)
	Get(ctx context.Context, largeFaceListID string) (result face.LargeFaceList, err error)
	GetFace(ctx context.Context, largeFaceListID string, persistedFaceID uuid.UUID) (result face.PersistedFace, err error)
	GetTrainingStatus(ctx context.Context, largeFaceListID string) (result face.TrainingStatus, err error)
	List(ctx context.Context) (result face.ListLargeFaceList, err error)
	ListFaces(ctx context.Context, largeFaceListID string, start string, top *int32) (result face.ListPersistedFace, err error)
	Train(ctx context.Context, largeFaceListID string) (result autorest.Response, err error)
	Update(ctx context.Context, largeFaceListID string, body face.NameAndUserDataContract) (result autorest.Response, err error)
	UpdateFace(ctx context.Context, largeFaceListID string, persistedFaceID uuid.UUID, body face.UpdateFaceRequest) (result autorest.Response, err error)
}

LargeFaceListClientAPI contains the set of methods on the LargeFaceListClient type.

type LargePersonGroupClientAPI

type LargePersonGroupClientAPI interface {
	Create(ctx context.Context, largePersonGroupID string, body face.NameAndUserDataContract) (result autorest.Response, err error)
	Delete(ctx context.Context, largePersonGroupID string) (result autorest.Response, err error)
	Get(ctx context.Context, largePersonGroupID string) (result face.LargePersonGroup, err error)
	GetTrainingStatus(ctx context.Context, largePersonGroupID string) (result face.TrainingStatus, err error)
	List(ctx context.Context, start string, top *int32) (result face.ListLargePersonGroup, err error)
	Train(ctx context.Context, largePersonGroupID string) (result autorest.Response, err error)
	Update(ctx context.Context, largePersonGroupID string, body face.NameAndUserDataContract) (result autorest.Response, err error)
}

LargePersonGroupClientAPI contains the set of methods on the LargePersonGroupClient type.

type LargePersonGroupPersonClientAPI

type LargePersonGroupPersonClientAPI interface {
	AddFaceFromStream(ctx context.Context, largePersonGroupID string, personID uuid.UUID, imageParameter io.ReadCloser, userData string, targetFace []int32) (result face.PersistedFace, err error)
	AddFaceFromURL(ctx context.Context, largePersonGroupID string, personID uuid.UUID, imageURL face.ImageURL, userData string, targetFace []int32) (result face.PersistedFace, err error)
	Create(ctx context.Context, largePersonGroupID string, body face.NameAndUserDataContract) (result face.Person, err error)
	Delete(ctx context.Context, largePersonGroupID string, personID uuid.UUID) (result autorest.Response, err error)
	DeleteFace(ctx context.Context, largePersonGroupID string, personID uuid.UUID, persistedFaceID uuid.UUID) (result autorest.Response, err error)
	Get(ctx context.Context, largePersonGroupID string, personID uuid.UUID) (result face.Person, err error)
	GetFace(ctx context.Context, largePersonGroupID string, personID uuid.UUID, persistedFaceID uuid.UUID) (result face.PersistedFace, err error)
	List(ctx context.Context, largePersonGroupID string, start string, top *int32) (result face.ListPerson, err error)
	Update(ctx context.Context, largePersonGroupID string, personID uuid.UUID, body face.NameAndUserDataContract) (result autorest.Response, err error)
	UpdateFace(ctx context.Context, largePersonGroupID string, personID uuid.UUID, persistedFaceID uuid.UUID, body face.UpdateFaceRequest) (result autorest.Response, err error)
}

LargePersonGroupPersonClientAPI contains the set of methods on the LargePersonGroupPersonClient type.

type ListClientAPI

type ListClientAPI interface {
	AddFaceFromStream(ctx context.Context, faceListID string, imageParameter io.ReadCloser, userData string, targetFace []int32) (result face.PersistedFace, err error)
	AddFaceFromURL(ctx context.Context, faceListID string, imageURL face.ImageURL, userData string, targetFace []int32) (result face.PersistedFace, err error)
	Create(ctx context.Context, faceListID string, body face.NameAndUserDataContract) (result autorest.Response, err error)
	Delete(ctx context.Context, faceListID string) (result autorest.Response, err error)
	DeleteFace(ctx context.Context, faceListID string, persistedFaceID uuid.UUID) (result autorest.Response, err error)
	Get(ctx context.Context, faceListID string) (result face.List, err error)
	List(ctx context.Context) (result face.ListList, err error)
	Update(ctx context.Context, faceListID string, body face.NameAndUserDataContract) (result autorest.Response, err error)
}

ListClientAPI contains the set of methods on the ListClient type.

type PersonGroupClientAPI

type PersonGroupClientAPI interface {
	Create(ctx context.Context, personGroupID string, body face.NameAndUserDataContract) (result autorest.Response, err error)
	Delete(ctx context.Context, personGroupID string) (result autorest.Response, err error)
	Get(ctx context.Context, personGroupID string) (result face.PersonGroup, err error)
	GetTrainingStatus(ctx context.Context, personGroupID string) (result face.TrainingStatus, err error)
	List(ctx context.Context, start string, top *int32) (result face.ListPersonGroup, err error)
	Train(ctx context.Context, personGroupID string) (result autorest.Response, err error)
	Update(ctx context.Context, personGroupID string, body face.NameAndUserDataContract) (result autorest.Response, err error)
}

PersonGroupClientAPI contains the set of methods on the PersonGroupClient type.

type PersonGroupPersonClientAPI

type PersonGroupPersonClientAPI interface {
	AddFaceFromStream(ctx context.Context, personGroupID string, personID uuid.UUID, imageParameter io.ReadCloser, userData string, targetFace []int32) (result face.PersistedFace, err error)
	AddFaceFromURL(ctx context.Context, personGroupID string, personID uuid.UUID, imageURL face.ImageURL, userData string, targetFace []int32) (result face.PersistedFace, err error)
	Create(ctx context.Context, personGroupID string, body face.NameAndUserDataContract) (result face.Person, err error)
	Delete(ctx context.Context, personGroupID string, personID uuid.UUID) (result autorest.Response, err error)
	DeleteFace(ctx context.Context, personGroupID string, personID uuid.UUID, persistedFaceID uuid.UUID) (result autorest.Response, err error)
	Get(ctx context.Context, personGroupID string, personID uuid.UUID) (result face.Person, err error)
	GetFace(ctx context.Context, personGroupID string, personID uuid.UUID, persistedFaceID uuid.UUID) (result face.PersistedFace, err error)
	List(ctx context.Context, personGroupID string, start string, top *int32) (result face.ListPerson, err error)
	Update(ctx context.Context, personGroupID string, personID uuid.UUID, body face.NameAndUserDataContract) (result autorest.Response, err error)
	UpdateFace(ctx context.Context, personGroupID string, personID uuid.UUID, persistedFaceID uuid.UUID, body face.UpdateFaceRequest) (result autorest.Response, err error)
}

PersonGroupPersonClientAPI contains the set of methods on the PersonGroupPersonClient type.

type SnapshotClientAPI

type SnapshotClientAPI interface {
	Apply(ctx context.Context, snapshotID uuid.UUID, body face.ApplySnapshotRequest) (result autorest.Response, err error)
	Delete(ctx context.Context, snapshotID uuid.UUID) (result autorest.Response, err error)
	Get(ctx context.Context, snapshotID uuid.UUID) (result face.Snapshot, err error)
	GetOperationStatus(ctx context.Context, operationID uuid.UUID) (result face.OperationStatus, err error)
	List(ctx context.Context, typeParameter face.SnapshotObjectType, applyScope []uuid.UUID) (result face.ListSnapshot, err error)
	Take(ctx context.Context, body face.TakeSnapshotRequest) (result autorest.Response, err error)
	Update(ctx context.Context, snapshotID uuid.UUID, body face.UpdateSnapshotRequest) (result autorest.Response, err error)
}

SnapshotClientAPI contains the set of methods on the SnapshotClient type.