Person

​

Overview

​

Rust Definition

#[derive(Serialize, Deserialize, Clone)]
pub struct Person {
    pub name: String,
    pub image_url: String,
}

​

TypeScript Definition

interface Person {
  name: string;
  image_url: string;
}

​

Fields

​

Example JSON

{
  "name": "Jane Smith",
  "image_url": "https://example.com/images/jane-smith.jpg"
}

​

Array Example

[
  {
    "name": "Alice Johnson",
    "image_url": "https://storage.example.com/faces/alice.jpg"
  },
  {
    "name": "Bob Williams",
    "image_url": "https://storage.example.com/faces/bob.jpg"
  },
  {
    "name": "Charlie Brown",
    "image_url": "https://storage.example.com/faces/charlie.jpg"
  }
]

​

Best Practices

​

Image Requirements

• Face Visibility: Ensure the face is clearly visible and not obscured
• Image Quality: Use high-resolution images for better accuracy
• Lighting: Well-lit images produce more accurate results
• Frontal View: Face-forward images work best, though slight angles are acceptable
• Single Face: Images should contain only one face or have the target face prominent

​

Naming Conventions

• Use consistent naming patterns across your application
• Consider using unique identifiers (UUIDs, database IDs) for guaranteed uniqueness
• Avoid special characters that might cause issues in your system

​

Image URL Requirements

• URLs must be publicly accessible (or accessible to the API service)
• Use HTTPS for security when possible
• Ensure images are hosted on reliable infrastructure
• Consider URL expiration times if using signed URLs

​

Related Models

• CompareRequest - Uses an array of Person objects
• MatchResult - References the person’s name in match results