FacePing API

Request: This endpoint expects a multipart/form-data request.

Example cURL:

curl -X POST "/groups/my-face-group/face?metadata[key1]=value1&metadata[key2]=value2" 
     -H "Content-Type: multipart/form-data" 
     -F "image=@path/to/your-image.jpg"

Here:

• Replace my-face-group with the desired group name.
• metadata parameters are added as query parameters. For example ?metadata[role]=admin.
• image is the file form field containing the face image (JPEG, PNG, etc.).

Example Response:

{
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "groupName": "my-face-group"
}

Request:

This endpoint expects a multipart/form-data request containing an image file.

Example cURL:

curl -X POST "/groups/my-face-group/faces/search?topK=5" \
     -H "Content-Type: multipart/form-data" \
     -F "queryImage=@path/to/query-image.jpg"

Response Example:

The response is a list of scored vectors:

[
  {
    "id": "123e4567-e89b-12d3-a456-426614174000",
    "score": 0.95,
    "metadata": {
      "fileName": "face1.jpg",
      "tag": "personA"
    }
  },
  {
    "id": "223e4567-e89b-12d3-a456-426614174000",
    "score": 0.90,
    "metadata": {
      "fileName": "face2.jpg",
      "tag": "personB"
    }
  }
]

Request (JSON):

{
  "vectorString": "0.1,0.2,0.3,0.4",
  "topK": 5
}

Example Response:

[
  {
    "id": "123e4567-e89b-12d3-a456-426614174000",
    "score": 0.95,
    "metadata": {
      "fileName": "face1.jpg",
      "tag": "personA"
    }
  }
]

After Processing Completion:

This operation processes images from a specified Google Drive folder. Once completed:

• Callback URL (if provided):
  A POST request will be sent to the provided callback URL with a JSON payload summarizing the process result.
  Example:

  {
    "totalFiles": 50,
    "successCount": 48,
    "failed": [
      {
        "fileName": "corrupted_image.jpg",
        "fileId": "abc123",
        "error": "Invalid image format."
      }
    ]
  }
  

• Email Notification (if email is provided):
  An email summarizing the results (total files processed, how many succeeded, how many failed) will be sent to the specified email address.
  This email contains the same information as the callback payload, presented in a readable format.

What to Expect:

• A structured JSON summary of all images processed.
• For successful images, their embeddings are stored in the specified group.
• For failed images, error details are included in the summary.

After Processing Completion:

This operation processes images from a specified FTP folder. Once completed:

• Callback URL (if provided):
  A POST request will be sent to your callback URL with a JSON summary of the process:

  {
    "totalFiles": 30,
    "successCount": 28,
    "failed": [
      {
        "fileName": "bad_image.png",
        "fileId": "/ftp/path/bad_image.png",
        "error": "Unable to generate embedding."
      }
    ]
  }
  

• Email Notification (if email is provided):
  An email will be sent to the provided email address summarizing the result of the FTP image processing.
  It includes the total number of files processed, how many succeeded, and the details of any failures.

What to Expect:

• A JSON payload (via callback) or an email summarizing processing results.
• Embedded vectors for successfully processed images stored in the specified group.
• Detailed error information for any failed images.