Files
tf_provider_immich/docs/resources/face.md
T

1.2 KiB

page_title, subcategory, description
page_title subcategory description
immich_face Resource - immich Manages an Immich face (detected or manual).

immich_face (Resource)

Manages an Immich face (detected or manual).

Example Usage

resource "immich_face" "manual" {
  asset_id        = "your-asset-uuid"
  person_id       = "your-person-uuid"
  bounding_box_x1 = 100.5
  bounding_box_y1 = 100.5
  bounding_box_x2 = 200.5
  bounding_box_y2 = 200.5
  image_height    = 1080
  image_width     = 1920
}

Schema

Required

  • asset_id (String) The ID of the asset this face belongs to.
  • bounding_box_x1 (Number) The left coordinate of the bounding box.
  • bounding_box_x2 (Number) The right coordinate of the bounding box.
  • bounding_box_y1 (Number) The top coordinate of the bounding box.
  • bounding_box_y2 (Number) The bottom coordinate of the bounding box.
  • image_height (Number) The height of the image in pixels.
  • image_width (Number) The width of the image in pixels.
  • person_id (String) The ID of the person associated with this face.

Read-Only

  • id (String) Unique identifier for the face.