Backup_Repos/stash
1
0
Fork 0
mirror of https://github.com/stashapp/stash.git synced 2025-12-06 08:26:00 +01:00
Code Issues Projects Releases Wiki Activity

Update Auto Tag/Identify documentation (#6371)

Browse source 
* Update Auto Tag documentation
* Update Identify documentation
This commit is contained in:
DogmaDragon 2025-12-03 22:48:36 +02:00 committed by GitHub
parent 63e8830db4
commit 3d044896ad
No known key found for this signature in database
GPG key ID: B5690EEEBB952194
2 changed files with 67 additions and 24 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

52
ui/v2.5/src/docs/en/Manual/AutoTagging.md
View file

@ -1,18 +1,48 @@
# Auto Tagging
# Auto Tag
When media filepaths or filenames contain a Performer, Studio, or Tag name, it is assigned those Performers, Studios, and Tags. It will **only** tag based on Performer, Studio, and Tag names that exist in your database.
Auto Tag automatically assigns Performers, Studios, and Tags to your media based on their names found in file paths or filenames. This task works for scenes, images, and galleries.
When the Performer/Studio/Tag name has multiple words, the search will include paths/filenames where the Performer/Studio/Tag name is separated with `.`, `-`, `_`, and whitespace characters.
This task is part of the advanced settings mode.
For example, auto tagging for performer `Jane Doe` will match the following filenames:
## Rules
* `Jane.Doe.1.mp4`
* `Jane_Doe.2.mp4`
* `Jane-Doe.3.mp4`
* `Jane Doe.4.mp4`
> **Important:** Auto Tag only works for names that already exist in your Stash database. It does not create new Performers, Studios, or Tags.
Matching is case insensitive, and should only match exact wording within word boundaries. For example, the tag `Jane Doe` will not match `Maryjane-Doe` or `Jane-Doen`, but will match `Mary-Jane-Doe`, `Jane-Doe_n`, and `[OF]jane doe`.
- Multi-word names are matched when words appear in order and are separated by any of these characters: `.`, `-`, `_`, or whitespace. These separators are treated as word boundaries.
- Matching is case-insensitive but requires complete words within word boundaries. Partial words or misspelled words will not match.
- Auto Tag does not match performer aliases. Aliases will not be considered during matching.
Auto tagging for specific Performers, Studios, and Tags can be performed from the individual Performer/Studio/Tag page.
### Examples (performer "Jane Doe")
> **Note:** Performer autotagging does not currently match on performer aliases.
**Matches:**
| Example | Explanation |
|---|---|
| `Jane.Doe.1.mp4` | Dot as separator. |
| `Jane_Doe.2.mp4` | Underscore as separator. |
| `Jane-Doe.3.mp4` | Hyphen as separator. |
| `Jane Doe.4.mp4` | Whitespace as separator. |
| `Mary-Jane-Doe` | Extra characters around word boundaries are allowed. |
| `Jane-Doe_n` | Extra characters around word boundaries are allowed. |
| `[OF]jane doe` | Extra characters around word boundaries are allowed. |
**Does not match:**
| Example | Explanation |
|---|---|
| `Maryjane-Doe` | Combined words without separator. |
| `Jane-Doen` | Spelling mismatch. |
### Organized flag
Scenes, images, and galleries that have the Organized flag added to them will not be modified by Auto Tag. You can also use Organized flag status as a filter.
### Ignore Auto Tag flag
Performers or Tags that have Ignore Auto Tag flag added to them will be skipped by the Auto Tag task.
## Running task
- **Auto Tag:** You can run the Auto Tag task on your entire library from the Tasks page.
- **Selective Auto Tag:** You can run the Auto Tag task on specific directories from the Tasks page.
- **Individual pages:** You can run Auto Tag tasks for specific Performers, Studios, and Tags from their respective pages.

39
ui/v2.5/src/docs/en/Manual/Identify.md
View file

@ -1,37 +1,50 @@
# Identify
The Identify task iterates through your Scenes and attempts to identify them using a selection of scraping sources. If a result is found in a source, the Scene is updated, and no further sources are checked for that scene.
This task is part of the advanced settings mode.
This task iterates through your Scenes and attempts to identify the scene using a selection of scraping sources.
## Rules
This task accepts one or more scraper sources. Valid scraper sources for the Identify task are stash-box instances, and scene scrapers which support scraping via Scene Fragment. The order of the sources may be rearranged.
- The task accepts one or more scraper sources, including stash-box instances and scene scrapers that support scraping via Scene Fragment. The order of the sources can be rearranged.
- The task iterates through the scraper sources in the provided order.
- If a result is found in a source, the Scene is updated, and further sources are not checked for that scene.
For each Scene, the Identify task iterates through the scraper sources, in the order provided, and tries to identify the scene using each source. If a result is found in a source, then the Scene is updated, and no further sources are checked for that scene.
### Organized flag
Scenes that have the Organized flag added to them will not be modified by Identify. You can also use Organized flag status as a filter.
## Options
The following options can be set:
The following options can be configured:
| Option | Description |
|--------|-------------|
| Include male performers | If false, then male performers will not be created or set on scenes. |
| Set cover images | If false, then scene cover images will not be modified. |
| Set organised flag | If true, the organised flag is set to true when a scene is organised. |
| Include male performers | If false, male performers will not be created or set on scenes. |
| Set cover images | If false, scene cover images will not be modified. |
| Set organized flag | If true, the organized flag is set to true when a scene is organized. |
| Skip matches that have more than one result | If this is not enabled and more than one result is returned, one will be randomly chosen to match |
| Tag skipped matches with | If the above option is set and a scene is skipped, this will add the tag so that you can filter for it in the Scene Tagger view and choose the correct match by hand |
| Skip single name performers with no disambiguation | If this is not enabled, performers that are often generic like Samantha or Olga will be matched |
| Tag skipped performers with | If the above options is set and a performer is skipped, this will add the tag so that you can filter for in it the Scene Tagger view and choose how you want to handle those performers |
| Tag skipped performers with | If the above option is set and a performer is skipped, this will add the tag so that you can filter for it in the Scene Tagger view and choose how you want to handle those performers |
Field specific options may be set as well. Each field may have a Strategy. The behaviour for each strategy value is as follows:
### Field specific options
Each field may have a strategy. The behavior for each strategy is as follows:
| Strategy | Description |
|----------|-------------|
| Ignore | Not set. |
| Overwrite | Overwrite existing value. |
| Ignore | The field is not set. |
| Overwrite | Existing values are overwritten. |
| Merge (*default*) | For multi-value fields, adds to existing values. For single-value fields, only sets if not already set. |
For Studio, Performers and Tags, an option is also available to Create Missing objects. This is enabled by default. When true, if a Studio/Performer/Tag is included during the identification process and does not exist in the system, then it will be created.
For Studio, Performers, and Tags, an option is available to **Create Missing Objects**. This is enabled by default. When true, if a Studio/Performer/Tag is included during the identification process and does not exist in the system, it will be created.
Default Options are applied to all sources unless overridden in specific source options.
## Running task
- **Identify...:** Run the Identify task on your entire library from the Tasks page.
- **Selective Identify:** Configure and run the Identify task on specific directories from Tasks > Identify... page. At the top of the page click folder icon to select directories.
## Logs
The result of the identification process for each scene is output to the log.