49 lines
1.2 KiB
Markdown
49 lines
1.2 KiB
Markdown
---
|
|
# generated by https://github.com/hashicorp/terraform-plugin-docs
|
|
page_title: "immich_faces Data Source - immich"
|
|
subcategory: ""
|
|
description: |-
|
|
Retrieves a list of faces for a specific asset.
|
|
---
|
|
|
|
# immich_faces (Data Source)
|
|
|
|
Retrieves a list of faces for a specific asset.
|
|
|
|
## Example Usage
|
|
|
|
```terraform
|
|
data "immich_faces" "current" {
|
|
asset_id = "your-asset-uuid"
|
|
}
|
|
|
|
output "detected_faces" {
|
|
value = data.immich_faces.current.faces
|
|
}
|
|
```
|
|
|
|
<!-- schema generated by tfplugindocs -->
|
|
## Schema
|
|
|
|
### Required
|
|
|
|
- `asset_id` (String) The ID of the asset.
|
|
|
|
### Read-Only
|
|
|
|
- `faces` (Attributes List) List of faces. (see [below for nested schema](#nestedatt--faces))
|
|
|
|
<a id="nestedatt--faces"></a>
|
|
### Nested Schema for `faces`
|
|
|
|
Read-Only:
|
|
|
|
- `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.
|
|
- `id` (String) Unique identifier for the face.
|
|
- `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.
|