Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/lightapis/compre-face-sdk
Exadel CompreFace Rest API TypeScript SDK
https://github.com/lightapis/compre-face-sdk
compreface compreface-sdk exadel face-recognition sdk
Last synced: 7 days ago
JSON representation
Exadel CompreFace Rest API TypeScript SDK
- Host: GitHub
- URL: https://github.com/lightapis/compre-face-sdk
- Owner: LightAPIs
- License: mit
- Created: 2023-10-08T13:07:17.000Z (about 1 year ago)
- Default Branch: main
- Last Pushed: 2024-01-12T11:05:08.000Z (10 months ago)
- Last Synced: 2024-09-19T23:14:04.279Z (about 2 months ago)
- Topics: compreface, compreface-sdk, exadel, face-recognition, sdk
- Language: TypeScript
- Homepage: https://www.npmjs.com/package/@dragonish/compre-face-sdk
- Size: 5.53 MB
- Stars: 0
- Watchers: 0
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# compre-face-sdk
Exadel CompreFace Rest API TypeScript SDK.
## Installation
```shell
npm install @dragonish/compre-face-sdk
```
## Usage
### Face Recognition Service
```typescript
import { FaceRecognitionService } from '@dragonish/compre-face-sdk';
const frs = new FaceRecognitionService('', '');
```
#### Methods
| Method name | Description |
| --- | --- |
| `addASubject()` | Add a Subject |
| `renameASubject()` | Rename a Subject |
| `deleteASubject()` | Delete a Subject |
| `deleteAllSubjects()` | Delete All Subjects |
| `listSubjects()` | List Subjects |
| `getURLOfAddAnExample()` | Get the full URL of "Add an Example of a Subject" |
| `addAnExample()` | Add an Example of a Subject |
| `listOfAllExamples()` | List of All Saved Examples of the Subject |
| `deleteAllExamplesOfTheSubject()` | Delete All Examples of the Subject by Name |
| `deleteAnExample()` | Delete an Example of the Subject by ID |
| `deleteMultipleExamples()` | Delete Multiple Examples |
| `DirectImageExample()` | Direct Download an Image example of the Subject by ID |
| `downloadImageExample()` | Download an Image example of the Subject by ID |
| `getURLOfRecognizeFaces()` | Get the full URL of "Recognize Faces from a Given Image" |
| `recognizeFaces()` | Recognize Faces from a Given Image |
| `recognizeFacesByEmbedding()` | Recognize Faces from a Given Image, Embedding |
| `getURLOfVerifyFaces()` | Get the full URL of "Verify Faces from a Given Image" |
| `verifyFaces()` | Verify Faces from a Given Image |
| `verifyFacesByEmbedding()` | Verify Faces from a Given Image, Embedding |
### Face Detection Service
```typescript
import { FaceDetectionService } from '@dragonish/compre-face-sdk';
const fds = new FaceDetectionService('', '');
```
#### Methods
| Method name | Description |
| --- | --- |
| `getURLOfFaceDetection()` | Get the full URL of "Face Detection Service" |
| `faceDetection()` | Face Detection Service |
### Face Verification Service
```typescript
import { FaceVerificationService } from '@dragonish/compre-face-sdk';
const fvs = new FaceVerificationService('', '');
```
#### Methods
| Method name | Description |
| --- | --- |
| `getURLOfFaceVerification()` | Get the full URL of "Face Verification Service" |
| `faceVerification()` | Face Verification Service |
| `faceVerificationByEmbedding()` | Face Verification Service, Embedding |
## Credits
- [exadel-inc/CompreFace](https://github.com/exadel-inc/CompreFace)
## License
[MIT](./LICENSE)