mirror of
https://github.com/paperless-ngx/paperless-ngx.git
synced 2026-07-30 15:45:58 +00:00
Compare commits
3
Commits
| Author | SHA1 | Date | |
|---|---|---|---|
|
|
0d429f65dc | ||
|
|
0bae0e2019 | ||
|
|
ffcab04e6a |
@@ -0,0 +1,12 @@
|
|||||||
|
#!/command/with-contenv /usr/bin/bash
|
||||||
|
# shellcheck shell=bash
|
||||||
|
|
||||||
|
declare -r log_prefix="[init-llmindex-migrate]"
|
||||||
|
|
||||||
|
echo "${log_prefix} Checking for pending LLM index migrations..."
|
||||||
|
cd "${PAPERLESS_SRC_DIR}"
|
||||||
|
if [[ -n "${USER_IS_NON_ROOT}" ]]; then
|
||||||
|
python3 manage.py document_llmindex migrate
|
||||||
|
else
|
||||||
|
s6-setuidgid paperless python3 manage.py document_llmindex migrate
|
||||||
|
fi
|
||||||
@@ -0,0 +1 @@
|
|||||||
|
oneshot
|
||||||
@@ -0,0 +1 @@
|
|||||||
|
/etc/s6-overlay/s6-rc.d/init-llmindex-migrate/run
|
||||||
+11
-1
@@ -212,6 +212,16 @@ following:
|
|||||||
This is a no-op if the index is already up to date, so it is safe to
|
This is a no-op if the index is already up to date, so it is safe to
|
||||||
run on every upgrade.
|
run on every upgrade.
|
||||||
|
|
||||||
|
5. Migrate the LLM index if needed.
|
||||||
|
|
||||||
|
```shell-session
|
||||||
|
cd src
|
||||||
|
python3 manage.py document_llmindex migrate
|
||||||
|
```
|
||||||
|
|
||||||
|
This is a no-op if the index schema is already current, so it is safe
|
||||||
|
to run on every upgrade.
|
||||||
|
|
||||||
### Database Upgrades
|
### Database Upgrades
|
||||||
|
|
||||||
Paperless-ngx is compatible with Django-supported versions of PostgreSQL and MariaDB and it is generally
|
Paperless-ngx is compatible with Django-supported versions of PostgreSQL and MariaDB and it is generally
|
||||||
@@ -532,7 +542,7 @@ index is updated automatically on the schedule set by
|
|||||||
can manage it manually:
|
can manage it manually:
|
||||||
|
|
||||||
```
|
```
|
||||||
document_llmindex {rebuild,update,compact}
|
document_llmindex {rebuild,update,compact,migrate}
|
||||||
```
|
```
|
||||||
|
|
||||||
Specify `rebuild` to build the index from scratch from all documents in the database. Use
|
Specify `rebuild` to build the index from scratch from all documents in the database. Use
|
||||||
|
|||||||
+10
-10
@@ -1849,7 +1849,7 @@
|
|||||||
</context-group>
|
</context-group>
|
||||||
<context-group purpose="location">
|
<context-group purpose="location">
|
||||||
<context context-type="sourcefile">src/app/components/common/custom-fields-query-dropdown/custom-fields-query-dropdown.component.html</context>
|
<context context-type="sourcefile">src/app/components/common/custom-fields-query-dropdown/custom-fields-query-dropdown.component.html</context>
|
||||||
<context context-type="linenumber">159</context>
|
<context context-type="linenumber">154</context>
|
||||||
</context-group>
|
</context-group>
|
||||||
<context-group purpose="location">
|
<context-group purpose="location">
|
||||||
<context context-type="sourcefile">src/app/components/common/filterable-dropdown/filterable-dropdown.component.html</context>
|
<context context-type="sourcefile">src/app/components/common/filterable-dropdown/filterable-dropdown.component.html</context>
|
||||||
@@ -3972,11 +3972,11 @@
|
|||||||
</context-group>
|
</context-group>
|
||||||
<context-group purpose="location">
|
<context-group purpose="location">
|
||||||
<context context-type="sourcefile">src/app/components/common/custom-fields-query-dropdown/custom-fields-query-dropdown.component.html</context>
|
<context context-type="sourcefile">src/app/components/common/custom-fields-query-dropdown/custom-fields-query-dropdown.component.html</context>
|
||||||
<context context-type="linenumber">101</context>
|
<context context-type="linenumber">96</context>
|
||||||
</context-group>
|
</context-group>
|
||||||
<context-group purpose="location">
|
<context-group purpose="location">
|
||||||
<context context-type="sourcefile">src/app/components/common/custom-fields-query-dropdown/custom-fields-query-dropdown.component.html</context>
|
<context context-type="sourcefile">src/app/components/common/custom-fields-query-dropdown/custom-fields-query-dropdown.component.html</context>
|
||||||
<context context-type="linenumber">107</context>
|
<context context-type="linenumber">102</context>
|
||||||
</context-group>
|
</context-group>
|
||||||
</trans-unit>
|
</trans-unit>
|
||||||
<trans-unit id="3800326155195149498" datatype="html">
|
<trans-unit id="3800326155195149498" datatype="html">
|
||||||
@@ -3987,11 +3987,11 @@
|
|||||||
</context-group>
|
</context-group>
|
||||||
<context-group purpose="location">
|
<context-group purpose="location">
|
||||||
<context context-type="sourcefile">src/app/components/common/custom-fields-query-dropdown/custom-fields-query-dropdown.component.html</context>
|
<context context-type="sourcefile">src/app/components/common/custom-fields-query-dropdown/custom-fields-query-dropdown.component.html</context>
|
||||||
<context context-type="linenumber">102</context>
|
<context context-type="linenumber">97</context>
|
||||||
</context-group>
|
</context-group>
|
||||||
<context-group purpose="location">
|
<context-group purpose="location">
|
||||||
<context context-type="sourcefile">src/app/components/common/custom-fields-query-dropdown/custom-fields-query-dropdown.component.html</context>
|
<context context-type="sourcefile">src/app/components/common/custom-fields-query-dropdown/custom-fields-query-dropdown.component.html</context>
|
||||||
<context context-type="linenumber">108</context>
|
<context context-type="linenumber">103</context>
|
||||||
</context-group>
|
</context-group>
|
||||||
</trans-unit>
|
</trans-unit>
|
||||||
<trans-unit id="7551700625201096185" datatype="html">
|
<trans-unit id="7551700625201096185" datatype="html">
|
||||||
@@ -4002,14 +4002,14 @@
|
|||||||
</context-group>
|
</context-group>
|
||||||
<context-group purpose="location">
|
<context-group purpose="location">
|
||||||
<context context-type="sourcefile">src/app/components/common/custom-fields-query-dropdown/custom-fields-query-dropdown.component.html</context>
|
<context context-type="sourcefile">src/app/components/common/custom-fields-query-dropdown/custom-fields-query-dropdown.component.html</context>
|
||||||
<context context-type="linenumber">124</context>
|
<context context-type="linenumber">119</context>
|
||||||
</context-group>
|
</context-group>
|
||||||
</trans-unit>
|
</trans-unit>
|
||||||
<trans-unit id="3184700926171002527" datatype="html">
|
<trans-unit id="3184700926171002527" datatype="html">
|
||||||
<source>Any</source>
|
<source>Any</source>
|
||||||
<context-group purpose="location">
|
<context-group purpose="location">
|
||||||
<context context-type="sourcefile">src/app/components/common/custom-fields-query-dropdown/custom-fields-query-dropdown.component.html</context>
|
<context context-type="sourcefile">src/app/components/common/custom-fields-query-dropdown/custom-fields-query-dropdown.component.html</context>
|
||||||
<context context-type="linenumber">157</context>
|
<context context-type="linenumber">152</context>
|
||||||
</context-group>
|
</context-group>
|
||||||
<context-group purpose="location">
|
<context-group purpose="location">
|
||||||
<context context-type="sourcefile">src/app/components/common/filterable-dropdown/filterable-dropdown.component.html</context>
|
<context context-type="sourcefile">src/app/components/common/filterable-dropdown/filterable-dropdown.component.html</context>
|
||||||
@@ -4020,21 +4020,21 @@
|
|||||||
<source>Not</source>
|
<source>Not</source>
|
||||||
<context-group purpose="location">
|
<context-group purpose="location">
|
||||||
<context context-type="sourcefile">src/app/components/common/custom-fields-query-dropdown/custom-fields-query-dropdown.component.html</context>
|
<context context-type="sourcefile">src/app/components/common/custom-fields-query-dropdown/custom-fields-query-dropdown.component.html</context>
|
||||||
<context context-type="linenumber">162</context>
|
<context context-type="linenumber">157</context>
|
||||||
</context-group>
|
</context-group>
|
||||||
</trans-unit>
|
</trans-unit>
|
||||||
<trans-unit id="6548676277933116532" datatype="html">
|
<trans-unit id="6548676277933116532" datatype="html">
|
||||||
<source>Add query</source>
|
<source>Add query</source>
|
||||||
<context-group purpose="location">
|
<context-group purpose="location">
|
||||||
<context context-type="sourcefile">src/app/components/common/custom-fields-query-dropdown/custom-fields-query-dropdown.component.html</context>
|
<context context-type="sourcefile">src/app/components/common/custom-fields-query-dropdown/custom-fields-query-dropdown.component.html</context>
|
||||||
<context context-type="linenumber">181</context>
|
<context context-type="linenumber">176</context>
|
||||||
</context-group>
|
</context-group>
|
||||||
</trans-unit>
|
</trans-unit>
|
||||||
<trans-unit id="5599577087865387184" datatype="html">
|
<trans-unit id="5599577087865387184" datatype="html">
|
||||||
<source>Add expression</source>
|
<source>Add expression</source>
|
||||||
<context-group purpose="location">
|
<context-group purpose="location">
|
||||||
<context context-type="sourcefile">src/app/components/common/custom-fields-query-dropdown/custom-fields-query-dropdown.component.html</context>
|
<context context-type="sourcefile">src/app/components/common/custom-fields-query-dropdown/custom-fields-query-dropdown.component.html</context>
|
||||||
<context context-type="linenumber">184</context>
|
<context context-type="linenumber">179</context>
|
||||||
</context-group>
|
</context-group>
|
||||||
</trans-unit>
|
</trans-unit>
|
||||||
<trans-unit id="6312759212949884929" datatype="html">
|
<trans-unit id="6312759212949884929" datatype="html">
|
||||||
|
|||||||
@@ -182,7 +182,7 @@
|
|||||||
container="body" triggers="mouseenter:mouseleave" popoverClass="popover-slim">
|
container="body" triggers="mouseenter:mouseleave" popoverClass="popover-slim">
|
||||||
<i-bs class="me-2" name="stack"></i-bs><span><ng-container i18n>Attributes</ng-container></span>
|
<i-bs class="me-2" name="stack"></i-bs><span><ng-container i18n>Attributes</ng-container></span>
|
||||||
</a>
|
</a>
|
||||||
@if (!slimSidebarEnabled && canSaveSettings) {
|
@if (!slimSidebarEnabled) {
|
||||||
<button
|
<button
|
||||||
type="button"
|
type="button"
|
||||||
class="btn btn-link btn-sm text-muted p-0 me-3 attributes-expand-btn"
|
class="btn btn-link btn-sm text-muted p-0 me-3 attributes-expand-btn"
|
||||||
|
|||||||
-5
@@ -68,11 +68,6 @@
|
|||||||
></ng-select>
|
></ng-select>
|
||||||
} @else if (getCustomFieldByID(atom.field)?.data_type === CustomFieldDataType.DocumentLink) {
|
} @else if (getCustomFieldByID(atom.field)?.data_type === CustomFieldDataType.DocumentLink) {
|
||||||
<pngx-input-document-link [(ngModel)]="atom.value" class="w-25 form-select doc-link-select p-0" placeholder="Search docs..." i18n-placeholder [minimal]="true"></pngx-input-document-link>
|
<pngx-input-document-link [(ngModel)]="atom.value" class="w-25 form-select doc-link-select p-0" placeholder="Search docs..." i18n-placeholder [minimal]="true"></pngx-input-document-link>
|
||||||
} @else if (getCustomFieldByID(atom.field)?.data_type === CustomFieldDataType.Monetary) {
|
|
||||||
<input class="w-25 form-control rounded-end" type="text" inputmode="decimal"
|
|
||||||
[ngModel]="atom.value"
|
|
||||||
(ngModelChange)="setMonetaryValue(atom, $event)"
|
|
||||||
[disabled]="disabled">
|
|
||||||
} @else {
|
} @else {
|
||||||
<input class="w-25 form-control rounded-end" type="text" [(ngModel)]="atom.value" [disabled]="disabled">
|
<input class="w-25 form-control rounded-end" type="text" [(ngModel)]="atom.value" [disabled]="disabled">
|
||||||
}
|
}
|
||||||
|
|||||||
-24
@@ -1,6 +1,5 @@
|
|||||||
import { provideHttpClient, withInterceptorsFromDi } from '@angular/common/http'
|
import { provideHttpClient, withInterceptorsFromDi } from '@angular/common/http'
|
||||||
import { provideHttpClientTesting } from '@angular/common/http/testing'
|
import { provideHttpClientTesting } from '@angular/common/http/testing'
|
||||||
import { LOCALE_ID } from '@angular/core'
|
|
||||||
import { ComponentFixture, TestBed } from '@angular/core/testing'
|
import { ComponentFixture, TestBed } from '@angular/core/testing'
|
||||||
import { FormsModule, ReactiveFormsModule } from '@angular/forms'
|
import { FormsModule, ReactiveFormsModule } from '@angular/forms'
|
||||||
import { NgbDropdownModule } from '@ng-bootstrap/ng-bootstrap'
|
import { NgbDropdownModule } from '@ng-bootstrap/ng-bootstrap'
|
||||||
@@ -42,12 +41,6 @@ const customFields = [
|
|||||||
],
|
],
|
||||||
},
|
},
|
||||||
},
|
},
|
||||||
{
|
|
||||||
id: 3,
|
|
||||||
name: 'Test Monetary Field',
|
|
||||||
data_type: CustomFieldDataType.Monetary,
|
|
||||||
extra_data: { default_currency: 'EUR' },
|
|
||||||
},
|
|
||||||
]
|
]
|
||||||
|
|
||||||
describe('CustomFieldsQueryDropdownComponent', () => {
|
describe('CustomFieldsQueryDropdownComponent', () => {
|
||||||
@@ -68,7 +61,6 @@ describe('CustomFieldsQueryDropdownComponent', () => {
|
|||||||
providers: [
|
providers: [
|
||||||
provideHttpClient(withInterceptorsFromDi()),
|
provideHttpClient(withInterceptorsFromDi()),
|
||||||
provideHttpClientTesting(),
|
provideHttpClientTesting(),
|
||||||
{ provide: LOCALE_ID, useValue: 'de' },
|
|
||||||
],
|
],
|
||||||
}).compileComponents()
|
}).compileComponents()
|
||||||
|
|
||||||
@@ -158,22 +150,6 @@ describe('CustomFieldsQueryDropdownComponent', () => {
|
|||||||
expect(options2).toEqual([])
|
expect(options2).toEqual([])
|
||||||
})
|
})
|
||||||
|
|
||||||
it('should normalize localized monetary comparison values', () => {
|
|
||||||
const atom = new CustomFieldQueryAtom([3, 'exact', null])
|
|
||||||
|
|
||||||
component.setMonetaryValue(atom, '1.234,56')
|
|
||||||
|
|
||||||
expect(atom.value).toEqual('1234.56')
|
|
||||||
})
|
|
||||||
|
|
||||||
it('should preserve API-formatted monetary comparison values', () => {
|
|
||||||
const atom = new CustomFieldQueryAtom([3, 'exact', null])
|
|
||||||
|
|
||||||
component.setMonetaryValue(atom, '1234.56')
|
|
||||||
|
|
||||||
expect(atom.value).toEqual('1234.56')
|
|
||||||
})
|
|
||||||
|
|
||||||
it('should remove an element from the selection model', () => {
|
it('should remove an element from the selection model', () => {
|
||||||
const expression = new CustomFieldQueryExpression()
|
const expression = new CustomFieldQueryExpression()
|
||||||
const atom = new CustomFieldQueryAtom()
|
const atom = new CustomFieldQueryAtom()
|
||||||
|
|||||||
+1
-21
@@ -1,14 +1,9 @@
|
|||||||
import {
|
import { NgTemplateOutlet } from '@angular/common'
|
||||||
getLocaleNumberSymbol,
|
|
||||||
NgTemplateOutlet,
|
|
||||||
NumberSymbol,
|
|
||||||
} from '@angular/common'
|
|
||||||
import {
|
import {
|
||||||
Component,
|
Component,
|
||||||
EventEmitter,
|
EventEmitter,
|
||||||
inject,
|
inject,
|
||||||
Input,
|
Input,
|
||||||
LOCALE_ID,
|
|
||||||
Output,
|
Output,
|
||||||
QueryList,
|
QueryList,
|
||||||
signal,
|
signal,
|
||||||
@@ -217,7 +212,6 @@ export class CustomFieldQueriesModel {
|
|||||||
})
|
})
|
||||||
export class CustomFieldsQueryDropdownComponent extends LoadingComponentWithPermissions {
|
export class CustomFieldsQueryDropdownComponent extends LoadingComponentWithPermissions {
|
||||||
protected customFieldsService = inject(CustomFieldsService)
|
protected customFieldsService = inject(CustomFieldsService)
|
||||||
private readonly locale = inject(LOCALE_ID)
|
|
||||||
|
|
||||||
public CustomFieldQueryComponentType = CustomFieldQueryElementType
|
public CustomFieldQueryComponentType = CustomFieldQueryElementType
|
||||||
public CustomFieldQueryOperator = CustomFieldQueryOperator
|
public CustomFieldQueryOperator = CustomFieldQueryOperator
|
||||||
@@ -382,18 +376,4 @@ export class CustomFieldsQueryDropdownComponent extends LoadingComponentWithPerm
|
|||||||
}
|
}
|
||||||
return []
|
return []
|
||||||
}
|
}
|
||||||
|
|
||||||
setMonetaryValue(atom: CustomFieldQueryAtom, value: string) {
|
|
||||||
// Normalize the decimal symbol e.g. . vs , by locale
|
|
||||||
const decimalSymbol = getLocaleNumberSymbol(
|
|
||||||
this.locale,
|
|
||||||
NumberSymbol.Decimal
|
|
||||||
)
|
|
||||||
if (decimalSymbol !== '.' && value.includes(decimalSymbol)) {
|
|
||||||
const groupSymbol = getLocaleNumberSymbol(this.locale, NumberSymbol.Group)
|
|
||||||
value = value.split(groupSymbol).join('').split(decimalSymbol).join('.')
|
|
||||||
}
|
|
||||||
|
|
||||||
atom.value = value
|
|
||||||
}
|
|
||||||
}
|
}
|
||||||
|
|||||||
+2
-2
@@ -51,8 +51,8 @@
|
|||||||
*pngxIfPermissions="{ action: PermissionAction.Add, type: activeManagementList.permissionType }">
|
*pngxIfPermissions="{ action: PermissionAction.Add, type: activeManagementList.permissionType }">
|
||||||
<i-bs name="plus-circle" class="me-1"></i-bs><ng-container i18n>Create</ng-container>
|
<i-bs name="plus-circle" class="me-1"></i-bs><ng-container i18n>Create</ng-container>
|
||||||
</button>
|
</button>
|
||||||
} @else if (customFieldsActive) {
|
} @else if (activeCustomFields) {
|
||||||
<button type="button" class="btn btn-sm btn-outline-primary" (click)="addCustomField()"
|
<button type="button" class="btn btn-sm btn-outline-primary" (click)="activeCustomFields.editField()"
|
||||||
*pngxIfPermissions="{ action: PermissionAction.Add, type: PermissionType.CustomField }">
|
*pngxIfPermissions="{ action: PermissionAction.Add, type: PermissionType.CustomField }">
|
||||||
<i-bs name="plus-circle" class="me-1"></i-bs><ng-container i18n>Add Field</ng-container>
|
<i-bs name="plus-circle" class="me-1"></i-bs><ng-container i18n>Add Field</ng-container>
|
||||||
</button>
|
</button>
|
||||||
|
|||||||
+1
-25
@@ -18,7 +18,6 @@ import {
|
|||||||
DocumentAttributesComponent,
|
DocumentAttributesComponent,
|
||||||
DocumentAttributesSectionKind,
|
DocumentAttributesSectionKind,
|
||||||
} from './document-attributes.component'
|
} from './document-attributes.component'
|
||||||
import { CustomFieldsComponent } from './custom-fields/custom-fields.component'
|
|
||||||
import { ManagementListComponent } from './management-list/management-list.component'
|
import { ManagementListComponent } from './management-list/management-list.component'
|
||||||
|
|
||||||
@Component({
|
@Component({
|
||||||
@@ -208,29 +207,6 @@ describe('DocumentAttributesComponent', () => {
|
|||||||
expect(component.activeSection.kind).toBe(
|
expect(component.activeSection.kind).toBe(
|
||||||
DocumentAttributesSectionKind.CustomFields
|
DocumentAttributesSectionKind.CustomFields
|
||||||
)
|
)
|
||||||
const customFields = Object.create(CustomFieldsComponent.prototype)
|
expect(component.activeCustomFields).toBeDefined()
|
||||||
customFields.editField = jest.fn()
|
|
||||||
component.activeOutlet = {
|
|
||||||
componentInstance: customFields,
|
|
||||||
} as any
|
|
||||||
expect(component.activeCustomFields).toBe(customFields)
|
|
||||||
|
|
||||||
component.addCustomField()
|
|
||||||
expect(customFields.editField).toHaveBeenCalled()
|
|
||||||
})
|
|
||||||
|
|
||||||
it('should show the add field button before the custom fields instance is available', async () => {
|
|
||||||
jest.spyOn(permissionsService, 'currentUserCan').mockReturnValue(true)
|
|
||||||
|
|
||||||
fixture.detectChanges()
|
|
||||||
component.activeNavID.set(2)
|
|
||||||
await fixture.whenStable()
|
|
||||||
|
|
||||||
expect(component.activeCustomFields).toBeNull()
|
|
||||||
expect(
|
|
||||||
fixture.nativeElement.querySelector(
|
|
||||||
'pngx-page-header .btn-outline-primary'
|
|
||||||
)?.textContent
|
|
||||||
).toContain('Add Field')
|
|
||||||
})
|
})
|
||||||
})
|
})
|
||||||
|
|||||||
+2
-11
@@ -163,17 +163,12 @@ export class DocumentAttributesComponent implements OnInit, OnDestroy {
|
|||||||
}
|
}
|
||||||
|
|
||||||
get activeCustomFields(): CustomFieldsComponent | null {
|
get activeCustomFields(): CustomFieldsComponent | null {
|
||||||
if (!this.customFieldsActive) return null
|
if (this.activeSection?.kind !== DocumentAttributesSectionKind.CustomFields)
|
||||||
|
return null
|
||||||
const instance = this.activeOutlet?.componentInstance
|
const instance = this.activeOutlet?.componentInstance
|
||||||
return instance instanceof CustomFieldsComponent ? instance : null
|
return instance instanceof CustomFieldsComponent ? instance : null
|
||||||
}
|
}
|
||||||
|
|
||||||
get customFieldsActive(): boolean {
|
|
||||||
return (
|
|
||||||
this.activeSection?.kind === DocumentAttributesSectionKind.CustomFields
|
|
||||||
)
|
|
||||||
}
|
|
||||||
|
|
||||||
get activeTabLabel(): string {
|
get activeTabLabel(): string {
|
||||||
return this.activeSection?.label ?? ''
|
return this.activeSection?.label ?? ''
|
||||||
}
|
}
|
||||||
@@ -229,10 +224,6 @@ export class DocumentAttributesComponent implements OnInit, OnDestroy {
|
|||||||
this.router.navigate(['attributes', nextSection])
|
this.router.navigate(['attributes', nextSection])
|
||||||
}
|
}
|
||||||
|
|
||||||
addCustomField(): void {
|
|
||||||
this.activeCustomFields?.editField(null)
|
|
||||||
}
|
|
||||||
|
|
||||||
private getDefaultNavID(): DocumentAttributesNavIDs | null {
|
private getDefaultNavID(): DocumentAttributesNavIDs | null {
|
||||||
return this.visibleSections[0]?.id ?? null
|
return this.visibleSections[0]?.id ?? null
|
||||||
}
|
}
|
||||||
|
|||||||
+25
-15
@@ -57,7 +57,9 @@ from paperless.models import ArchiveFileGenerationChoices
|
|||||||
from paperless.parsers import ParserContext
|
from paperless.parsers import ParserContext
|
||||||
from paperless.parsers import ParserProtocol
|
from paperless.parsers import ParserProtocol
|
||||||
from paperless.parsers.registry import get_parser_registry
|
from paperless.parsers.registry import get_parser_registry
|
||||||
from paperless.parsers.utils import pdf_born_digital_text
|
from paperless.parsers.utils import PDF_TEXT_MIN_LENGTH
|
||||||
|
from paperless.parsers.utils import extract_pdf_text
|
||||||
|
from paperless.parsers.utils import is_tagged_pdf
|
||||||
|
|
||||||
LOGGING_NAME: Final[str] = "paperless.consumer"
|
LOGGING_NAME: Final[str] = "paperless.consumer"
|
||||||
|
|
||||||
@@ -136,45 +138,53 @@ def should_produce_archive(
|
|||||||
|
|
||||||
# Must produce a PDF so the frontend can display the original format at all.
|
# Must produce a PDF so the frontend can display the original format at all.
|
||||||
if parser.requires_pdf_rendition:
|
if parser.requires_pdf_rendition:
|
||||||
_log.debug("Archive: yes - parser requires PDF rendition for frontend display")
|
_log.debug("Archive: yes — parser requires PDF rendition for frontend display")
|
||||||
return True
|
return True
|
||||||
|
|
||||||
# Parser cannot produce an archive (e.g. TextDocumentParser).
|
# Parser cannot produce an archive (e.g. TextDocumentParser).
|
||||||
if not parser.can_produce_archive:
|
if not parser.can_produce_archive:
|
||||||
_log.debug("Archive: no - parser cannot produce archives")
|
_log.debug("Archive: no — parser cannot produce archives")
|
||||||
return False
|
return False
|
||||||
|
|
||||||
generation = OcrConfig().archive_file_generation
|
generation = OcrConfig().archive_file_generation
|
||||||
|
|
||||||
if generation == ArchiveFileGenerationChoices.ALWAYS:
|
if generation == ArchiveFileGenerationChoices.ALWAYS:
|
||||||
_log.debug("Archive: yes - ARCHIVE_FILE_GENERATION=always")
|
_log.debug("Archive: yes — ARCHIVE_FILE_GENERATION=always")
|
||||||
return True
|
return True
|
||||||
if generation == ArchiveFileGenerationChoices.NEVER:
|
if generation == ArchiveFileGenerationChoices.NEVER:
|
||||||
_log.debug("Archive: no - ARCHIVE_FILE_GENERATION=never")
|
_log.debug("Archive: no — ARCHIVE_FILE_GENERATION=never")
|
||||||
return False
|
return False
|
||||||
|
|
||||||
# auto: produce archives for scanned/image documents; skip for born-digital PDFs.
|
# auto: produce archives for scanned/image documents; skip for born-digital PDFs.
|
||||||
if mime_type.startswith("image/"):
|
if mime_type.startswith("image/"):
|
||||||
_log.debug("Archive: yes - image document, ARCHIVE_FILE_GENERATION=auto")
|
_log.debug("Archive: yes — image document, ARCHIVE_FILE_GENERATION=auto")
|
||||||
return True
|
return True
|
||||||
if mime_type == "application/pdf":
|
if mime_type == "application/pdf":
|
||||||
text, born_digital = pdf_born_digital_text(document_path, log=_log)
|
text = extract_pdf_text(document_path)
|
||||||
text_length = len(text) if text else 0
|
has_text = text is not None and len(text) > 0
|
||||||
if born_digital:
|
if has_text and is_tagged_pdf(document_path):
|
||||||
_log.debug(
|
_log.debug(
|
||||||
"Archive: no - born-digital PDF (text_length=%d),"
|
"Archive: no — born-digital PDF (structure tags detected),"
|
||||||
" ARCHIVE_FILE_GENERATION=auto",
|
" ARCHIVE_FILE_GENERATION=auto",
|
||||||
text_length,
|
|
||||||
)
|
)
|
||||||
return False
|
return False
|
||||||
|
if text is None or len(text) <= PDF_TEXT_MIN_LENGTH:
|
||||||
|
_log.debug(
|
||||||
|
"Archive: yes — scanned PDF (text_length=%d ≤ %d),"
|
||||||
|
" ARCHIVE_FILE_GENERATION=auto",
|
||||||
|
len(text) if text else 0,
|
||||||
|
PDF_TEXT_MIN_LENGTH,
|
||||||
|
)
|
||||||
|
return True
|
||||||
_log.debug(
|
_log.debug(
|
||||||
"Archive: yes - scanned/textless PDF (text_length=%d),"
|
"Archive: no — born-digital PDF (text_length=%d > %d),"
|
||||||
" ARCHIVE_FILE_GENERATION=auto",
|
" ARCHIVE_FILE_GENERATION=auto",
|
||||||
text_length,
|
len(text),
|
||||||
|
PDF_TEXT_MIN_LENGTH,
|
||||||
)
|
)
|
||||||
return True
|
return False
|
||||||
_log.debug(
|
_log.debug(
|
||||||
"Archive: no - MIME type %r not eligible for auto archive generation",
|
"Archive: no — MIME type %r not eligible for auto archive generation",
|
||||||
mime_type,
|
mime_type,
|
||||||
)
|
)
|
||||||
return False
|
return False
|
||||||
|
|||||||
@@ -3,6 +3,7 @@ from typing import Any
|
|||||||
from documents.management.commands.base import PaperlessCommand
|
from documents.management.commands.base import PaperlessCommand
|
||||||
from documents.tasks import llmindex_index
|
from documents.tasks import llmindex_index
|
||||||
from paperless_ai.indexing import llm_index_compact
|
from paperless_ai.indexing import llm_index_compact
|
||||||
|
from paperless_ai.indexing import llm_index_migrate
|
||||||
|
|
||||||
|
|
||||||
class Command(PaperlessCommand):
|
class Command(PaperlessCommand):
|
||||||
@@ -13,12 +14,18 @@ class Command(PaperlessCommand):
|
|||||||
|
|
||||||
def add_arguments(self, parser: Any) -> None:
|
def add_arguments(self, parser: Any) -> None:
|
||||||
super().add_arguments(parser)
|
super().add_arguments(parser)
|
||||||
parser.add_argument("command", choices=["rebuild", "update", "compact"])
|
parser.add_argument(
|
||||||
|
"command",
|
||||||
|
choices=["rebuild", "update", "compact", "migrate"],
|
||||||
|
)
|
||||||
|
|
||||||
def handle(self, *args: Any, **options: Any) -> None:
|
def handle(self, *args: Any, **options: Any) -> None:
|
||||||
if options["command"] == "compact":
|
if options["command"] == "compact":
|
||||||
llm_index_compact()
|
llm_index_compact()
|
||||||
return
|
return
|
||||||
|
if options["command"] == "migrate":
|
||||||
|
llm_index_migrate()
|
||||||
|
return
|
||||||
llmindex_index(
|
llmindex_index(
|
||||||
rebuild=options["command"] == "rebuild",
|
rebuild=options["command"] == "rebuild",
|
||||||
iter_wrapper=lambda docs: self.track(
|
iter_wrapper=lambda docs: self.track(
|
||||||
|
|||||||
@@ -61,7 +61,7 @@ class Command(PaperlessCommand):
|
|||||||
)
|
)
|
||||||
table.add_column("Level", width=7, no_wrap=True)
|
table.add_column("Level", width=7, no_wrap=True)
|
||||||
table.add_column("Document", min_width=20)
|
table.add_column("Document", min_width=20)
|
||||||
table.add_column("Issue", ratio=1, overflow="fold")
|
table.add_column("Issue", ratio=1)
|
||||||
|
|
||||||
for doc_pk, doc_messages in messages.iter_messages():
|
for doc_pk, doc_messages in messages.iter_messages():
|
||||||
if doc_pk is not None:
|
if doc_pk is not None:
|
||||||
|
|||||||
@@ -9,6 +9,7 @@ if TYPE_CHECKING:
|
|||||||
|
|
||||||
_COMPACT = "documents.management.commands.document_llmindex.llm_index_compact"
|
_COMPACT = "documents.management.commands.document_llmindex.llm_index_compact"
|
||||||
_INDEX = "documents.management.commands.document_llmindex.llmindex_index"
|
_INDEX = "documents.management.commands.document_llmindex.llmindex_index"
|
||||||
|
_MIGRATE = "documents.management.commands.document_llmindex.llm_index_migrate"
|
||||||
|
|
||||||
|
|
||||||
class TestDocumentLlmindexCommand:
|
class TestDocumentLlmindexCommand:
|
||||||
@@ -17,6 +18,11 @@ class TestDocumentLlmindexCommand:
|
|||||||
call_command("document_llmindex", "compact")
|
call_command("document_llmindex", "compact")
|
||||||
mock_compact.assert_called_once_with()
|
mock_compact.assert_called_once_with()
|
||||||
|
|
||||||
|
def test_migrate_calls_llm_index_migrate(self, mocker: MockerFixture) -> None:
|
||||||
|
mock_migrate = mocker.patch(_MIGRATE)
|
||||||
|
call_command("document_llmindex", "migrate")
|
||||||
|
mock_migrate.assert_called_once_with()
|
||||||
|
|
||||||
def test_rebuild_calls_llmindex_index_with_rebuild_true(
|
def test_rebuild_calls_llmindex_index_with_rebuild_true(
|
||||||
self,
|
self,
|
||||||
mocker: MockerFixture,
|
mocker: MockerFixture,
|
||||||
|
|||||||
@@ -1329,7 +1329,7 @@ class PreConsumeTestCase(DirectoriesMixin, GetConsumerMixin, TestCase):
|
|||||||
with self.get_consumer(self.test_file) as c:
|
with self.get_consumer(self.test_file) as c:
|
||||||
c.run()
|
c.run()
|
||||||
# Verify no pre-consume script subprocess was invoked
|
# Verify no pre-consume script subprocess was invoked
|
||||||
# (run_subprocess may still be called by pdf_born_digital_text via pdftotext)
|
# (run_subprocess may still be called by _extract_text_for_archive_check)
|
||||||
script_calls = [
|
script_calls = [
|
||||||
call
|
call
|
||||||
for call in m.call_args_list
|
for call in m.call_args_list
|
||||||
@@ -1354,7 +1354,7 @@ class PreConsumeTestCase(DirectoriesMixin, GetConsumerMixin, TestCase):
|
|||||||
self.assertTrue(m.called)
|
self.assertTrue(m.called)
|
||||||
|
|
||||||
# Find the call that invoked the pre-consume script
|
# Find the call that invoked the pre-consume script
|
||||||
# (run_subprocess may also be called by pdf_born_digital_text via pdftotext)
|
# (run_subprocess may also be called by _extract_text_for_archive_check)
|
||||||
script_call = next(
|
script_call = next(
|
||||||
call
|
call
|
||||||
for call in m.call_args_list
|
for call in m.call_args_list
|
||||||
|
|||||||
@@ -134,32 +134,60 @@ class TestShouldProduceArchive:
|
|||||||
assert should_produce_archive(parser, mime, Path("/tmp/doc")) is expected
|
assert should_produce_archive(parser, mime, Path("/tmp/doc")) is expected
|
||||||
|
|
||||||
@pytest.mark.parametrize(
|
@pytest.mark.parametrize(
|
||||||
("born_digital", "expected"),
|
("extracted_text", "expected"),
|
||||||
[
|
[
|
||||||
pytest.param(True, False, id="born-digital-skips-archive"),
|
pytest.param(
|
||||||
pytest.param(False, True, id="not-born-digital-produces-archive"),
|
"This is a born-digital PDF with lots of text content. " * 10,
|
||||||
|
False,
|
||||||
|
id="born-digital-long-text-skips-archive",
|
||||||
|
),
|
||||||
|
pytest.param(None, True, id="no-text-scanned-produces-archive"),
|
||||||
|
pytest.param("tiny", True, id="short-text-treated-as-scanned"),
|
||||||
],
|
],
|
||||||
)
|
)
|
||||||
def test_auto_pdf_archive_decision(
|
def test_auto_pdf_archive_decision(
|
||||||
self,
|
self,
|
||||||
mocker: MockerFixture,
|
mocker: MockerFixture,
|
||||||
settings,
|
settings,
|
||||||
born_digital: bool, # noqa: FBT001
|
extracted_text: str | None,
|
||||||
expected: bool, # noqa: FBT001
|
expected: bool, # noqa: FBT001
|
||||||
) -> None:
|
) -> None:
|
||||||
"""Archive decision tracks pdf_born_digital_text()'s verdict exactly.
|
|
||||||
|
|
||||||
should_produce_archive() defers entirely to pdf_born_digital_text()
|
|
||||||
for the has-real-text decision, so both callers of that predicate
|
|
||||||
(this function and RasterisedDocumentParser.parse()) always agree.
|
|
||||||
"""
|
|
||||||
settings.ARCHIVE_FILE_GENERATION = "auto"
|
settings.ARCHIVE_FILE_GENERATION = "auto"
|
||||||
mocker.patch(
|
mocker.patch("documents.consumer.is_tagged_pdf", return_value=False)
|
||||||
"documents.consumer.pdf_born_digital_text",
|
mocker.patch("documents.consumer.extract_pdf_text", return_value=extracted_text)
|
||||||
return_value=("some text", born_digital),
|
|
||||||
)
|
|
||||||
parser = _parser_instance(can_produce=True, requires_rendition=False)
|
parser = _parser_instance(can_produce=True, requires_rendition=False)
|
||||||
assert (
|
assert (
|
||||||
should_produce_archive(parser, "application/pdf", Path("/tmp/doc.pdf"))
|
should_produce_archive(parser, "application/pdf", Path("/tmp/doc.pdf"))
|
||||||
is expected
|
is expected
|
||||||
)
|
)
|
||||||
|
|
||||||
|
def test_tagged_pdf_skips_archive_in_auto_mode(
|
||||||
|
self,
|
||||||
|
mocker: MockerFixture,
|
||||||
|
settings,
|
||||||
|
) -> None:
|
||||||
|
"""Tagged PDFs (e.g. Word exports) with real text are treated as born-digital, even below PDF_TEXT_MIN_LENGTH."""
|
||||||
|
settings.ARCHIVE_FILE_GENERATION = "auto"
|
||||||
|
mocker.patch("documents.consumer.is_tagged_pdf", return_value=True)
|
||||||
|
mocker.patch("documents.consumer.extract_pdf_text", return_value="tiny")
|
||||||
|
parser = _parser_instance(can_produce=True, requires_rendition=False)
|
||||||
|
assert (
|
||||||
|
should_produce_archive(parser, "application/pdf", Path("/tmp/doc.pdf"))
|
||||||
|
is False
|
||||||
|
)
|
||||||
|
|
||||||
|
def test_tagged_pdf_without_text_produces_archive(
|
||||||
|
self,
|
||||||
|
mocker: MockerFixture,
|
||||||
|
settings,
|
||||||
|
) -> None:
|
||||||
|
"""A tagged PDF with no actual extractable text (e.g. some scanner firmware) is not
|
||||||
|
trusted as born-digital — the tag alone must not bypass OCR."""
|
||||||
|
settings.ARCHIVE_FILE_GENERATION = "auto"
|
||||||
|
mocker.patch("documents.consumer.is_tagged_pdf", return_value=True)
|
||||||
|
mocker.patch("documents.consumer.extract_pdf_text", return_value=None)
|
||||||
|
parser = _parser_instance(can_produce=True, requires_rendition=False)
|
||||||
|
assert (
|
||||||
|
should_produce_archive(parser, "application/pdf", Path("/tmp/doc.pdf"))
|
||||||
|
is True
|
||||||
|
)
|
||||||
|
|||||||
@@ -3,6 +3,7 @@ from __future__ import annotations
|
|||||||
import importlib.resources
|
import importlib.resources
|
||||||
import logging
|
import logging
|
||||||
import os
|
import os
|
||||||
|
import re
|
||||||
import shutil
|
import shutil
|
||||||
import tempfile
|
import tempfile
|
||||||
from pathlib import Path
|
from pathlib import Path
|
||||||
@@ -24,9 +25,9 @@ from paperless.config import OcrConfig
|
|||||||
from paperless.models import CleanChoices
|
from paperless.models import CleanChoices
|
||||||
from paperless.models import ModeChoices
|
from paperless.models import ModeChoices
|
||||||
from paperless.models import OutputTypeChoices
|
from paperless.models import OutputTypeChoices
|
||||||
|
from paperless.parsers.utils import PDF_TEXT_MIN_LENGTH
|
||||||
from paperless.parsers.utils import extract_pdf_text
|
from paperless.parsers.utils import extract_pdf_text
|
||||||
from paperless.parsers.utils import is_born_digital_text
|
from paperless.parsers.utils import is_tagged_pdf
|
||||||
from paperless.parsers.utils import post_process_text
|
|
||||||
from paperless.parsers.utils import read_file_handle_unicode_errors
|
from paperless.parsers.utils import read_file_handle_unicode_errors
|
||||||
from paperless.version import __full_version_str__
|
from paperless.version import __full_version_str__
|
||||||
|
|
||||||
@@ -509,10 +510,10 @@ class RasterisedDocumentParser:
|
|||||||
|
|
||||||
if mime_type == "application/pdf":
|
if mime_type == "application/pdf":
|
||||||
text_original = self.extract_text(None, document_path)
|
text_original = self.extract_text(None, document_path)
|
||||||
original_has_text = is_born_digital_text(
|
has_text = text_original is not None and len(text_original) > 0
|
||||||
text_original,
|
original_has_text = has_text and (
|
||||||
document_path,
|
is_tagged_pdf(document_path, log=self.log)
|
||||||
log=self.log,
|
or len(text_original) > PDF_TEXT_MIN_LENGTH
|
||||||
)
|
)
|
||||||
else:
|
else:
|
||||||
text_original = None
|
text_original = None
|
||||||
@@ -657,3 +658,17 @@ class RasterisedDocumentParser:
|
|||||||
f"No text was found in {document_path}, the content will be empty.",
|
f"No text was found in {document_path}, the content will be empty.",
|
||||||
)
|
)
|
||||||
self.text = ""
|
self.text = ""
|
||||||
|
|
||||||
|
|
||||||
|
def post_process_text(text: str | None) -> str | None:
|
||||||
|
if not text:
|
||||||
|
return None
|
||||||
|
|
||||||
|
collapsed_spaces = re.sub(r"([^\S\r\n]+)", " ", text)
|
||||||
|
no_leading_whitespace = re.sub(r"([\n\r]+)([^\S\n\r]+)", "\\1", collapsed_spaces)
|
||||||
|
no_trailing_whitespace = re.sub(r"([^\S\n\r]+)$", "", no_leading_whitespace)
|
||||||
|
|
||||||
|
# TODO: this needs a rework
|
||||||
|
# replace \0 prevents issues with saving to postgres.
|
||||||
|
# text may contain \0 when this character is present in PDF files.
|
||||||
|
return no_trailing_whitespace.strip().replace("\0", " ")
|
||||||
|
|||||||
@@ -111,88 +111,6 @@ def extract_pdf_text(
|
|||||||
return None
|
return None
|
||||||
|
|
||||||
|
|
||||||
def post_process_text(text: str | None) -> str | None:
|
|
||||||
"""Normalize extracted PDF/OCR text: collapse whitespace, strip padding.
|
|
||||||
|
|
||||||
Returns ``None`` for ``None`` or whitespace-only input, so callers can
|
|
||||||
treat "no text" and "only layout padding" the same way.
|
|
||||||
"""
|
|
||||||
if not text:
|
|
||||||
return None
|
|
||||||
|
|
||||||
collapsed_spaces = re.sub(r"([^\S\r\n]+)", " ", text)
|
|
||||||
no_leading_whitespace = re.sub(r"([\n\r]+)([^\S\n\r]+)", "\\1", collapsed_spaces)
|
|
||||||
no_trailing_whitespace = re.sub(r"([^\S\n\r]+)$", "", no_leading_whitespace)
|
|
||||||
|
|
||||||
# replace \0 prevents issues with saving to postgres.
|
|
||||||
# text may contain \0 when this character is present in PDF files.
|
|
||||||
result = no_trailing_whitespace.strip().replace("\0", " ")
|
|
||||||
return result or None
|
|
||||||
|
|
||||||
|
|
||||||
def is_born_digital_text(
|
|
||||||
text: str | None,
|
|
||||||
path: Path,
|
|
||||||
log: logging.Logger | None = None,
|
|
||||||
) -> bool:
|
|
||||||
"""Decide whether already-extracted, normalized PDF text counts as born-digital.
|
|
||||||
|
|
||||||
This is the single source of truth for "does this PDF already have real
|
|
||||||
text", used both to decide whether to produce an archive file and to
|
|
||||||
decide whether OCR can be skipped. Both decisions must agree, or a
|
|
||||||
tagged-but-textless PDF can end up with no archive AND a forced OCR pass
|
|
||||||
(see GH #13387): raw ``pdftotext -layout`` output can be non-empty
|
|
||||||
(whitespace/form-feed padding) even when there is no real content, so
|
|
||||||
*text* must already be normalized via :func:`post_process_text`, not the
|
|
||||||
raw extraction.
|
|
||||||
|
|
||||||
Parameters
|
|
||||||
----------
|
|
||||||
text:
|
|
||||||
The normalized extracted text (or ``None``) to evaluate.
|
|
||||||
path:
|
|
||||||
Absolute path to the PDF file, used for the tagged-PDF check.
|
|
||||||
log:
|
|
||||||
Logger for warnings. Falls back to the module-level logger when omitted.
|
|
||||||
|
|
||||||
Returns
|
|
||||||
-------
|
|
||||||
bool
|
|
||||||
Whether the PDF counts as born-digital (has real text, and is either
|
|
||||||
tagged or exceeds ``PDF_TEXT_MIN_LENGTH``).
|
|
||||||
"""
|
|
||||||
if not text:
|
|
||||||
return False
|
|
||||||
return is_tagged_pdf(path, log=log) or len(text) > PDF_TEXT_MIN_LENGTH
|
|
||||||
|
|
||||||
|
|
||||||
def pdf_born_digital_text(
|
|
||||||
path: Path,
|
|
||||||
log: logging.Logger | None = None,
|
|
||||||
) -> tuple[str | None, bool]:
|
|
||||||
"""Extract a PDF's text and decide whether it should be treated as born-digital.
|
|
||||||
|
|
||||||
Convenience wrapper around :func:`is_born_digital_text` for callers that
|
|
||||||
don't already have the PDF's text extracted (e.g. the archive-generation
|
|
||||||
decision, which runs before any parser has touched the file).
|
|
||||||
|
|
||||||
Parameters
|
|
||||||
----------
|
|
||||||
path:
|
|
||||||
Absolute path to the PDF file.
|
|
||||||
log:
|
|
||||||
Logger for warnings. Falls back to the module-level logger when omitted.
|
|
||||||
|
|
||||||
Returns
|
|
||||||
-------
|
|
||||||
tuple[str | None, bool]
|
|
||||||
The normalized extracted text (or ``None``), and whether the PDF
|
|
||||||
counts as born-digital.
|
|
||||||
"""
|
|
||||||
text = post_process_text(extract_pdf_text(path, log=log))
|
|
||||||
return text, is_born_digital_text(text, path, log=log)
|
|
||||||
|
|
||||||
|
|
||||||
def read_file_handle_unicode_errors(
|
def read_file_handle_unicode_errors(
|
||||||
filepath: Path,
|
filepath: Path,
|
||||||
log: logging.Logger | None = None,
|
log: logging.Logger | None = None,
|
||||||
|
|||||||
@@ -36,23 +36,6 @@ def samples_dir() -> Path:
|
|||||||
return (Path(__file__).parent / "samples").resolve()
|
return (Path(__file__).parent / "samples").resolve()
|
||||||
|
|
||||||
|
|
||||||
@pytest.fixture(scope="session")
|
|
||||||
def tagged_no_text_pdf_file(samples_dir: Path) -> Path:
|
|
||||||
"""Path to a tagged PDF whose only "text" is pdftotext layout padding.
|
|
||||||
|
|
||||||
Reproduces GH #13387: ``/MarkInfo /Marked true`` is set, but the only
|
|
||||||
extractable content is a form-feed byte, not real text. Lives here
|
|
||||||
rather than in parsers/conftest.py so both parser tests and
|
|
||||||
paperless/tests/test_parser_utils.py can use it.
|
|
||||||
|
|
||||||
Returns
|
|
||||||
-------
|
|
||||||
Path
|
|
||||||
Absolute path to ``tesseract/tagged-but-no-text.pdf``.
|
|
||||||
"""
|
|
||||||
return samples_dir / "tesseract" / "tagged-but-no-text.pdf"
|
|
||||||
|
|
||||||
|
|
||||||
@pytest.fixture(autouse=True)
|
@pytest.fixture(autouse=True)
|
||||||
def clean_registry() -> Generator[None, None, None]:
|
def clean_registry() -> Generator[None, None, None]:
|
||||||
"""Reset the parser registry before and after every test.
|
"""Reset the parser registry before and after every test.
|
||||||
|
|||||||
@@ -21,7 +21,7 @@ from documents.parsers import run_convert
|
|||||||
from paperless.models import ModeChoices
|
from paperless.models import ModeChoices
|
||||||
from paperless.parsers import ParserProtocol
|
from paperless.parsers import ParserProtocol
|
||||||
from paperless.parsers.tesseract import RasterisedDocumentParser
|
from paperless.parsers.tesseract import RasterisedDocumentParser
|
||||||
from paperless.parsers.utils import is_tagged_pdf
|
from paperless.parsers.tesseract import post_process_text
|
||||||
|
|
||||||
if TYPE_CHECKING:
|
if TYPE_CHECKING:
|
||||||
from pathlib import Path
|
from pathlib import Path
|
||||||
@@ -151,6 +151,36 @@ class TestRasterisedDocumentParserLifecycle:
|
|||||||
assert tempdir is not None and not tempdir.exists()
|
assert tempdir is not None and not tempdir.exists()
|
||||||
|
|
||||||
|
|
||||||
|
# ---------------------------------------------------------------------------
|
||||||
|
# post_process_text
|
||||||
|
# ---------------------------------------------------------------------------
|
||||||
|
|
||||||
|
|
||||||
|
class TestPostProcessText:
|
||||||
|
@pytest.mark.parametrize(
|
||||||
|
("source", "expected"),
|
||||||
|
[
|
||||||
|
pytest.param(
|
||||||
|
"simple string",
|
||||||
|
"simple string",
|
||||||
|
id="collapse-spaces",
|
||||||
|
),
|
||||||
|
pytest.param(
|
||||||
|
"simple newline\n testing string",
|
||||||
|
"simple newline\ntesting string",
|
||||||
|
id="preserve-newline",
|
||||||
|
),
|
||||||
|
pytest.param(
|
||||||
|
"utf-8 строка с пробелами в конце ", # noqa: RUF001
|
||||||
|
"utf-8 строка с пробелами в конце", # noqa: RUF001
|
||||||
|
id="utf8-trailing-spaces",
|
||||||
|
),
|
||||||
|
],
|
||||||
|
)
|
||||||
|
def test_post_process_text(self, source: str, expected: str) -> None:
|
||||||
|
assert post_process_text(source) == expected
|
||||||
|
|
||||||
|
|
||||||
# ---------------------------------------------------------------------------
|
# ---------------------------------------------------------------------------
|
||||||
# Page count
|
# Page count
|
||||||
# ---------------------------------------------------------------------------
|
# ---------------------------------------------------------------------------
|
||||||
@@ -880,25 +910,25 @@ class TestSkipArchive:
|
|||||||
self,
|
self,
|
||||||
mocker: MockerFixture,
|
mocker: MockerFixture,
|
||||||
tesseract_parser: RasterisedDocumentParser,
|
tesseract_parser: RasterisedDocumentParser,
|
||||||
tagged_no_text_pdf_file: Path,
|
tesseract_samples_dir: Path,
|
||||||
) -> None:
|
) -> None:
|
||||||
"""
|
"""
|
||||||
GIVEN:
|
GIVEN:
|
||||||
- A real PDF that reports itself as tagged (/MarkInfo /Marked
|
- A PDF that reports itself as tagged (/MarkInfo /Marked true) but
|
||||||
true) but whose only pdftotext output is layout padding (a
|
has no actual extractable text (some scanner firmware produces
|
||||||
lone form-feed byte), not real text (see GitHub issue #13387,
|
this — see GitHub issue #13349)
|
||||||
originally reported against #13349's tagged-PDF handling)
|
|
||||||
- Mode: auto, produce_archive=False
|
- Mode: auto, produce_archive=False
|
||||||
WHEN:
|
WHEN:
|
||||||
- Document is parsed
|
- Document is parsed
|
||||||
THEN:
|
THEN:
|
||||||
- The tag alone is not trusted as "has text"; OCRmyPDF still runs
|
- The tag alone is not trusted as "has text"; OCRmyPDF still runs
|
||||||
"""
|
"""
|
||||||
assert is_tagged_pdf(tagged_no_text_pdf_file) is True
|
|
||||||
tesseract_parser.settings.mode = ModeChoices.AUTO
|
tesseract_parser.settings.mode = ModeChoices.AUTO
|
||||||
|
mocker.patch("paperless.parsers.tesseract.is_tagged_pdf", return_value=True)
|
||||||
|
mocker.patch.object(tesseract_parser, "extract_text", return_value=None)
|
||||||
mock_ocr = mocker.patch("ocrmypdf.ocr")
|
mock_ocr = mocker.patch("ocrmypdf.ocr")
|
||||||
tesseract_parser.parse(
|
tesseract_parser.parse(
|
||||||
tagged_no_text_pdf_file,
|
tesseract_samples_dir / "multi-page-images.pdf",
|
||||||
"application/pdf",
|
"application/pdf",
|
||||||
produce_archive=False,
|
produce_archive=False,
|
||||||
)
|
)
|
||||||
|
|||||||
Binary file not shown.
@@ -4,18 +4,10 @@ from __future__ import annotations
|
|||||||
|
|
||||||
import codecs
|
import codecs
|
||||||
from pathlib import Path
|
from pathlib import Path
|
||||||
from typing import TYPE_CHECKING
|
|
||||||
|
|
||||||
import pytest
|
|
||||||
|
|
||||||
from paperless.parsers.utils import is_tagged_pdf
|
from paperless.parsers.utils import is_tagged_pdf
|
||||||
from paperless.parsers.utils import pdf_born_digital_text
|
|
||||||
from paperless.parsers.utils import post_process_text
|
|
||||||
from paperless.parsers.utils import read_file_handle_unicode_errors
|
from paperless.parsers.utils import read_file_handle_unicode_errors
|
||||||
|
|
||||||
if TYPE_CHECKING:
|
|
||||||
from pytest_mock import MockerFixture
|
|
||||||
|
|
||||||
SAMPLES = Path(__file__).parent / "samples" / "tesseract"
|
SAMPLES = Path(__file__).parent / "samples" / "tesseract"
|
||||||
|
|
||||||
|
|
||||||
@@ -68,105 +60,3 @@ class TestIsTaggedPdf:
|
|||||||
bad = tmp_path / "bad.pdf"
|
bad = tmp_path / "bad.pdf"
|
||||||
bad.write_bytes(b"not a pdf")
|
bad.write_bytes(b"not a pdf")
|
||||||
assert is_tagged_pdf(bad) is False
|
assert is_tagged_pdf(bad) is False
|
||||||
|
|
||||||
|
|
||||||
class TestPostProcessText:
|
|
||||||
@pytest.mark.parametrize(
|
|
||||||
("source", "expected"),
|
|
||||||
[
|
|
||||||
pytest.param(
|
|
||||||
"simple string",
|
|
||||||
"simple string",
|
|
||||||
id="collapse-spaces",
|
|
||||||
),
|
|
||||||
pytest.param(
|
|
||||||
"simple newline\n testing string",
|
|
||||||
"simple newline\ntesting string",
|
|
||||||
id="preserve-newline",
|
|
||||||
),
|
|
||||||
pytest.param(
|
|
||||||
"utf-8 строка с пробелами в конце ", # noqa: RUF001
|
|
||||||
"utf-8 строка с пробелами в конце", # noqa: RUF001
|
|
||||||
id="utf8-trailing-spaces",
|
|
||||||
),
|
|
||||||
pytest.param(None, None, id="none-input"),
|
|
||||||
pytest.param("", None, id="empty-string"),
|
|
||||||
pytest.param(" \n\x0c \n ", None, id="whitespace-and-formfeed-only"),
|
|
||||||
],
|
|
||||||
)
|
|
||||||
def test_post_process_text(
|
|
||||||
self,
|
|
||||||
source: str | None,
|
|
||||||
expected: str | None,
|
|
||||||
) -> None:
|
|
||||||
assert post_process_text(source) == expected
|
|
||||||
|
|
||||||
|
|
||||||
class TestPdfBornDigitalText:
|
|
||||||
"""Regression coverage for GH #13387.
|
|
||||||
|
|
||||||
should_produce_archive() and RasterisedDocumentParser.parse() must agree
|
|
||||||
on whether a PDF has real text, so both go through this one function.
|
|
||||||
"""
|
|
||||||
|
|
||||||
@pytest.mark.parametrize(
|
|
||||||
("extracted", "tagged", "expected_text", "expected_born_digital"),
|
|
||||||
[
|
|
||||||
pytest.param("tiny", True, "tiny", True, id="tagged-with-real-text"),
|
|
||||||
pytest.param("tiny", False, "tiny", False, id="untagged-below-min-length"),
|
|
||||||
pytest.param(
|
|
||||||
"x" * 51,
|
|
||||||
False,
|
|
||||||
"x" * 51,
|
|
||||||
True,
|
|
||||||
id="untagged-above-min-length",
|
|
||||||
),
|
|
||||||
pytest.param(None, True, None, False, id="tagged-but-no-text"),
|
|
||||||
],
|
|
||||||
)
|
|
||||||
def test_born_digital_decision(
|
|
||||||
self,
|
|
||||||
mocker: MockerFixture,
|
|
||||||
tmp_path: Path,
|
|
||||||
extracted: str | None,
|
|
||||||
tagged: bool, # noqa: FBT001
|
|
||||||
expected_text: str | None,
|
|
||||||
expected_born_digital: bool, # noqa: FBT001
|
|
||||||
) -> None:
|
|
||||||
"""
|
|
||||||
GIVEN:
|
|
||||||
- A PDF whose pdftotext output and /MarkInfo tag status vary
|
|
||||||
WHEN:
|
|
||||||
- pdf_born_digital_text() is called
|
|
||||||
THEN:
|
|
||||||
- The normalized text and born-digital verdict match; the tag
|
|
||||||
alone never counts as "has text"
|
|
||||||
"""
|
|
||||||
mocker.patch(
|
|
||||||
"paperless.parsers.utils.extract_pdf_text",
|
|
||||||
return_value=extracted,
|
|
||||||
)
|
|
||||||
mocker.patch("paperless.parsers.utils.is_tagged_pdf", return_value=tagged)
|
|
||||||
text, born_digital = pdf_born_digital_text(tmp_path / "doc.pdf")
|
|
||||||
assert text == expected_text
|
|
||||||
assert born_digital is expected_born_digital
|
|
||||||
|
|
||||||
def test_tagged_but_textless_pdf_is_not_born_digital(
|
|
||||||
self,
|
|
||||||
tagged_no_text_pdf_file: Path,
|
|
||||||
) -> None:
|
|
||||||
"""
|
|
||||||
GIVEN:
|
|
||||||
- A real PDF that is tagged (/MarkInfo /Marked true) but whose
|
|
||||||
only "text" is layout padding (a stray form-feed byte)
|
|
||||||
WHEN:
|
|
||||||
- pdf_born_digital_text() is called with no mocking
|
|
||||||
THEN:
|
|
||||||
- The normalized text is None and the PDF is not treated as
|
|
||||||
born-digital. The raw, unnormalized pdftotext output is
|
|
||||||
non-empty for this file, which is exactly what caused the
|
|
||||||
archive decision to disagree with the OCR decision in #13387.
|
|
||||||
"""
|
|
||||||
text, born_digital = pdf_born_digital_text(tagged_no_text_pdf_file)
|
|
||||||
assert text is None
|
|
||||||
assert born_digital is False
|
|
||||||
|
|||||||
@@ -144,6 +144,24 @@ def _exclude_readers():
|
|||||||
lock.close()
|
lock.close()
|
||||||
|
|
||||||
|
|
||||||
|
def _with_exclusive_access(operation: str, fn):
|
||||||
|
"""Run ``fn()`` with exclusive index access (see ``_exclude_readers()``),
|
||||||
|
for compaction/migration file swaps that must not run while readers are
|
||||||
|
active. Returns ``fn()``'s result, or None (after logging) if active
|
||||||
|
readers do not drain within ``LLM_INDEX_COMPACTION_LOCK_TIMEOUT`` --
|
||||||
|
callers skip the operation this run; it retries next time.
|
||||||
|
"""
|
||||||
|
try:
|
||||||
|
with _exclude_readers():
|
||||||
|
return fn()
|
||||||
|
except Timeout:
|
||||||
|
logger.info(
|
||||||
|
"Skipping LLM index %s: index readers are active; will retry next run.",
|
||||||
|
operation,
|
||||||
|
)
|
||||||
|
return None
|
||||||
|
|
||||||
|
|
||||||
@contextmanager
|
@contextmanager
|
||||||
def write_store(embed_model_name: str | None = None):
|
def write_store(embed_model_name: str | None = None):
|
||||||
"""Acquire the write lock and yield the vector store.
|
"""Acquire the write lock and yield the vector store.
|
||||||
@@ -168,6 +186,21 @@ def write_store(embed_model_name: str | None = None):
|
|||||||
yield store
|
yield store
|
||||||
|
|
||||||
|
|
||||||
|
def _check_and_run_migrations(store: "PaperlessSqliteVecVectorStore") -> bool:
|
||||||
|
"""Run any pending structural migrations, returning True if a pending
|
||||||
|
re-embed migration needs the caller to force a rebuild -- never
|
||||||
|
triggered automatically here. Safe to call before any write, including
|
||||||
|
delete()/upsert_document(): has_pending_migration() (see its docstring)
|
||||||
|
keeps this a no-op, with no exclusive access taken, once the store is
|
||||||
|
current.
|
||||||
|
"""
|
||||||
|
if not store.has_pending_migration():
|
||||||
|
return False
|
||||||
|
return bool(
|
||||||
|
_with_exclusive_access("migration check", store.check_and_run_migrations),
|
||||||
|
)
|
||||||
|
|
||||||
|
|
||||||
def _safe_related_name(document: Document, field: str) -> str | None:
|
def _safe_related_name(document: Document, field: str) -> str | None:
|
||||||
"""
|
"""
|
||||||
Returns the ``name`` of a related object (correspondent, document_type,
|
Returns the ``name`` of a related object (correspondent, document_type,
|
||||||
@@ -339,15 +372,7 @@ def update_llm_index(
|
|||||||
happens, since a rebuild always covers the whole library regardless.
|
happens, since a rebuild always covers the whole library regardless.
|
||||||
"""
|
"""
|
||||||
with write_store() as store:
|
with write_store() as store:
|
||||||
try:
|
needs_reembed = _check_and_run_migrations(store)
|
||||||
with _exclude_readers():
|
|
||||||
needs_reembed = store.check_and_run_migrations()
|
|
||||||
except Timeout:
|
|
||||||
logger.info(
|
|
||||||
"Skipping LLM index migration check: index readers are active; "
|
|
||||||
"will retry next run.",
|
|
||||||
)
|
|
||||||
needs_reembed = False
|
|
||||||
if needs_reembed:
|
if needs_reembed:
|
||||||
logger.warning(
|
logger.warning(
|
||||||
"LLM index migration requires re-embedding; forcing rebuild.",
|
"LLM index migration requires re-embedding; forcing rebuild.",
|
||||||
@@ -412,14 +437,7 @@ def update_llm_index(
|
|||||||
else "No changes detected in LLM index."
|
else "No changes detected in LLM index."
|
||||||
)
|
)
|
||||||
|
|
||||||
try:
|
_with_exclusive_access("compaction", store.compact)
|
||||||
with _exclude_readers():
|
|
||||||
store.compact()
|
|
||||||
except Timeout:
|
|
||||||
logger.info(
|
|
||||||
"Skipping LLM index compaction: index readers are active; "
|
|
||||||
"will retry next run.",
|
|
||||||
)
|
|
||||||
return msg
|
return msg
|
||||||
|
|
||||||
|
|
||||||
@@ -434,25 +452,60 @@ def llm_index_add_or_update_document(document: Document):
|
|||||||
_embed_nodes(new_nodes, get_embedding_model(config))
|
_embed_nodes(new_nodes, get_embedding_model(config))
|
||||||
|
|
||||||
with write_store(embed_model_name=get_configured_model_name(config)) as store:
|
with write_store(embed_model_name=get_configured_model_name(config)) as store:
|
||||||
|
needs_reembed = _check_and_run_migrations(store)
|
||||||
|
if needs_reembed:
|
||||||
|
logger.warning(
|
||||||
|
"Skipping incremental LLM index update for document %s: the "
|
||||||
|
"index requires re-embedding first. Run 'document_llmindex "
|
||||||
|
"rebuild' to resolve.",
|
||||||
|
document.id,
|
||||||
|
)
|
||||||
|
return
|
||||||
store.upsert_document(str(document.id), new_nodes)
|
store.upsert_document(str(document.id), new_nodes)
|
||||||
|
|
||||||
|
|
||||||
|
def llm_index_migrate() -> None:
|
||||||
|
"""Apply any pending LLM index schema migrations, with no reindex.
|
||||||
|
|
||||||
|
Intended to run unconditionally on every startup (see the
|
||||||
|
init-llmindex-migrate container step and the bare-metal upgrade docs):
|
||||||
|
has_pending_migration() short-circuits to a metadata-only read once the
|
||||||
|
store is current, so a healthy install pays almost nothing here. Only
|
||||||
|
ever applies structural migrations -- a pending re-embed migration is
|
||||||
|
left for the explicit, deliberate rebuild path (``document_llmindex
|
||||||
|
update``/``rebuild``) to resolve, since re-embedding can be slow and,
|
||||||
|
for a metered embedding backend, cost money.
|
||||||
|
"""
|
||||||
|
if not AIConfig().llm_index_enabled:
|
||||||
|
return
|
||||||
|
with write_store() as store:
|
||||||
|
needs_reembed = _check_and_run_migrations(store)
|
||||||
|
if needs_reembed:
|
||||||
|
logger.warning(
|
||||||
|
"LLM index requires re-embedding, which this automatic migration "
|
||||||
|
"check will not do on its own -- it can be slow and, for a "
|
||||||
|
"metered embedding backend, cost money. Run "
|
||||||
|
"'document_llmindex rebuild' manually when ready.",
|
||||||
|
)
|
||||||
|
|
||||||
|
|
||||||
def llm_index_compact() -> None:
|
def llm_index_compact() -> None:
|
||||||
"""Compact the index immediately, rebuilding the table to reclaim space."""
|
"""Compact the index immediately, rebuilding the table to reclaim space."""
|
||||||
with write_store() as store:
|
with write_store() as store:
|
||||||
try:
|
_with_exclusive_access("compaction", lambda: store.compact(force=True))
|
||||||
with _exclude_readers():
|
|
||||||
store.compact(force=True)
|
|
||||||
except Timeout:
|
|
||||||
logger.info(
|
|
||||||
"Skipping LLM index compaction: index readers are active; "
|
|
||||||
"will retry next run.",
|
|
||||||
)
|
|
||||||
|
|
||||||
|
|
||||||
def llm_index_remove_document(document: Document):
|
def llm_index_remove_document(document: Document):
|
||||||
"""Remove a document's chunks from the LLM index."""
|
"""Remove a document's chunks from the LLM index."""
|
||||||
with write_store() as store:
|
with write_store() as store:
|
||||||
|
if _check_and_run_migrations(store):
|
||||||
|
logger.warning(
|
||||||
|
"Skipping removal of document %s from the LLM index: the "
|
||||||
|
"index requires re-embedding first. Run 'document_llmindex "
|
||||||
|
"rebuild' to resolve.",
|
||||||
|
document.id,
|
||||||
|
)
|
||||||
|
return
|
||||||
store.delete(str(document.id))
|
store.delete(str(document.id))
|
||||||
|
|
||||||
|
|
||||||
|
|||||||
@@ -0,0 +1,60 @@
|
|||||||
|
"""Schema migrations for the sqlite-vec vector store.
|
||||||
|
|
||||||
|
Each migration lives in its own module here, named ``mNNNN_description.py``
|
||||||
|
(e.g. ``m0001_v1_to_v2.py`` -- a leading digit isn't a valid Python
|
||||||
|
identifier, hence the ``m`` prefix, unlike Django's own numbered migrations,
|
||||||
|
which load via a dynamic ``importlib.import_module()`` call rather than a
|
||||||
|
static import statement), and registers itself into ``MIGRATIONS`` at import
|
||||||
|
time. ``vector_store.py`` imports those modules at the bottom of the file,
|
||||||
|
purely for that registration side effect, after ``PaperlessSqliteVecVectorStore``
|
||||||
|
is fully defined -- migrations need it to implement ``apply()`` (see
|
||||||
|
``Migration`` below).
|
||||||
|
|
||||||
|
To add a new migration: add a new ``mNNNN_description.py`` module here that
|
||||||
|
imports ``PaperlessSqliteVecVectorStore`` from ``paperless_ai.vector_store``,
|
||||||
|
defines its ``apply()``, and appends a ``Migration`` to ``MIGRATIONS``; then
|
||||||
|
import that module at the bottom of ``vector_store.py`` and bump
|
||||||
|
``SCHEMA_VERSION`` there. A migration must freeze its own historical DDL for
|
||||||
|
any side table its target version depends on (``DROP TABLE IF EXISTS`` +
|
||||||
|
its own literal ``CREATE TABLE``/``CREATE INDEX`` statements) rather than
|
||||||
|
delegating to any "current schema" helper -- see ``m0001_v1_to_v2.py`` for
|
||||||
|
why and the worked example.
|
||||||
|
"""
|
||||||
|
|
||||||
|
import sqlite3
|
||||||
|
from collections.abc import Callable
|
||||||
|
from dataclasses import dataclass
|
||||||
|
from dataclasses import field
|
||||||
|
from typing import Literal
|
||||||
|
|
||||||
|
|
||||||
|
@dataclass
|
||||||
|
class Migration:
|
||||||
|
"""A schema migration for the sqlite-vec vector store.
|
||||||
|
|
||||||
|
kind="structural": rows are copied into a new-schema file with no
|
||||||
|
re-embedding needed. Supply ``apply(src_conn, dst_conn, dim)``, which
|
||||||
|
must create every table its target schema needs in ``dst_conn`` and copy
|
||||||
|
``src_conn``'s rows and relevant ``index_meta`` keys into it.
|
||||||
|
``schema_version`` is written by the migration runner after ``apply``
|
||||||
|
returns, not by ``apply`` itself.
|
||||||
|
|
||||||
|
kind="re-embed": the new schema requires fresh embeddings.
|
||||||
|
``check_and_run_migrations()`` returns True when it encounters one of
|
||||||
|
these so the caller can force a full rebuild (which recreates the table
|
||||||
|
at the current SCHEMA_VERSION).
|
||||||
|
"""
|
||||||
|
|
||||||
|
from_version: int
|
||||||
|
to_version: int
|
||||||
|
kind: Literal["structural", "re-embed"]
|
||||||
|
description: str
|
||||||
|
apply: Callable[[sqlite3.Connection, sqlite3.Connection, int], None] | None = field(
|
||||||
|
default=None,
|
||||||
|
repr=False,
|
||||||
|
)
|
||||||
|
|
||||||
|
|
||||||
|
# Registry of all schema migrations in order, populated by each migration
|
||||||
|
# module's import-time registration (see the module docstring above).
|
||||||
|
MIGRATIONS: list[Migration] = []
|
||||||
@@ -0,0 +1,229 @@
|
|||||||
|
"""Thin gateways over the plain relational side tables that sit alongside the
|
||||||
|
vec0 table. Each method takes the sqlite3.Connection to operate on
|
||||||
|
explicitly, rather than owning one -- the store swaps connections during
|
||||||
|
compact()/migration, and migrations always work across two connections
|
||||||
|
(src_conn, dst_conn) at once.
|
||||||
|
|
||||||
|
PRECONDITION: Callers must set conn.row_factory = sqlite3.Row before passing a
|
||||||
|
connection to any of these gateways' read methods. The read methods across all
|
||||||
|
three classes (DocumentChunksTable.chunk_ids_for_document, IndexMetaTable._get,
|
||||||
|
DocumentMetaTable.all_modified_times, DocumentMetaTable.copy_all) use
|
||||||
|
row["column_name"] dictionary-style indexing, which requires sqlite3.Row as the
|
||||||
|
row factory -- without it, sqlite3.Row is not set, rows are returned as plain
|
||||||
|
tuples, and tuple indices must be integers, raising TypeError.
|
||||||
|
"""
|
||||||
|
|
||||||
|
import sqlite3
|
||||||
|
from collections.abc import Iterable
|
||||||
|
from typing import NamedTuple
|
||||||
|
|
||||||
|
|
||||||
|
class ChunkRow(NamedTuple):
|
||||||
|
chunk_id: str
|
||||||
|
document_id: int
|
||||||
|
|
||||||
|
|
||||||
|
class DocumentMetaRow(NamedTuple):
|
||||||
|
document_id: int
|
||||||
|
modified: str
|
||||||
|
|
||||||
|
|
||||||
|
class DocumentChunksTable:
|
||||||
|
"""chunk_id -> document_id, indexed by document_id. Gives O(1)
|
||||||
|
per-document chunk lookup that vec0's own document_id metadata column
|
||||||
|
cannot (see PaperlessSqliteVecVectorStore._delete_chunks_by_document_id).
|
||||||
|
"""
|
||||||
|
|
||||||
|
@staticmethod
|
||||||
|
def create(conn: sqlite3.Connection) -> None:
|
||||||
|
conn.execute(
|
||||||
|
"CREATE TABLE IF NOT EXISTS document_chunks "
|
||||||
|
"(chunk_id TEXT PRIMARY KEY, document_id INTEGER NOT NULL)",
|
||||||
|
)
|
||||||
|
conn.execute(
|
||||||
|
"CREATE INDEX IF NOT EXISTS idx_document_chunks_document_id "
|
||||||
|
"ON document_chunks (document_id)",
|
||||||
|
)
|
||||||
|
|
||||||
|
@staticmethod
|
||||||
|
def insert_many(conn: sqlite3.Connection, rows: Iterable[ChunkRow]) -> None:
|
||||||
|
"""rows must already be batch-bounded by the caller (e.g. vec0's own
|
||||||
|
fetchmany() loop) -- this never reads, so it can't itself introduce
|
||||||
|
an unbounded scan, but a whole-table iterable defeats the point."""
|
||||||
|
conn.executemany(
|
||||||
|
"INSERT INTO document_chunks (chunk_id, document_id) VALUES (?, ?)",
|
||||||
|
rows,
|
||||||
|
)
|
||||||
|
|
||||||
|
@staticmethod
|
||||||
|
def chunk_ids_for_document(
|
||||||
|
conn: sqlite3.Connection,
|
||||||
|
document_id: int,
|
||||||
|
) -> list[str]:
|
||||||
|
return [
|
||||||
|
row["chunk_id"]
|
||||||
|
for row in conn.execute(
|
||||||
|
"SELECT chunk_id FROM document_chunks WHERE document_id = ?",
|
||||||
|
(document_id,),
|
||||||
|
).fetchall()
|
||||||
|
]
|
||||||
|
|
||||||
|
@staticmethod
|
||||||
|
def delete_for_document(conn: sqlite3.Connection, document_id: int) -> None:
|
||||||
|
conn.execute(
|
||||||
|
"DELETE FROM document_chunks WHERE document_id = ?",
|
||||||
|
(document_id,),
|
||||||
|
)
|
||||||
|
|
||||||
|
@staticmethod
|
||||||
|
def delete_all(conn: sqlite3.Connection) -> None:
|
||||||
|
conn.execute("DELETE FROM document_chunks")
|
||||||
|
|
||||||
|
@staticmethod
|
||||||
|
def count(conn: sqlite3.Connection) -> int:
|
||||||
|
"""Cheap stand-in for vec0's own row count -- see compact()."""
|
||||||
|
return conn.execute("SELECT count(*) FROM document_chunks").fetchone()[0]
|
||||||
|
|
||||||
|
|
||||||
|
class DocumentMetaTable:
|
||||||
|
"""document_id -> modified, one row per document. Lives outside vec0
|
||||||
|
because vec0 only inlines TEXT metadata up to 12 bytes and `modified`
|
||||||
|
(an ISO timestamp) is always longer.
|
||||||
|
"""
|
||||||
|
|
||||||
|
@staticmethod
|
||||||
|
def create(conn: sqlite3.Connection) -> None:
|
||||||
|
conn.execute(
|
||||||
|
"CREATE TABLE IF NOT EXISTS document_meta "
|
||||||
|
"(document_id INTEGER PRIMARY KEY, modified TEXT NOT NULL)",
|
||||||
|
)
|
||||||
|
|
||||||
|
@staticmethod
|
||||||
|
def upsert_many(
|
||||||
|
conn: sqlite3.Connection,
|
||||||
|
rows: Iterable[DocumentMetaRow],
|
||||||
|
) -> None:
|
||||||
|
conn.executemany(
|
||||||
|
"INSERT INTO document_meta (document_id, modified) VALUES (?, ?) "
|
||||||
|
"ON CONFLICT(document_id) DO UPDATE SET modified = excluded.modified",
|
||||||
|
rows,
|
||||||
|
)
|
||||||
|
|
||||||
|
@staticmethod
|
||||||
|
def delete_for_document(conn: sqlite3.Connection, document_id: int) -> None:
|
||||||
|
conn.execute(
|
||||||
|
"DELETE FROM document_meta WHERE document_id = ?",
|
||||||
|
(document_id,),
|
||||||
|
)
|
||||||
|
|
||||||
|
@staticmethod
|
||||||
|
def delete_all(conn: sqlite3.Connection) -> None:
|
||||||
|
conn.execute("DELETE FROM document_meta")
|
||||||
|
|
||||||
|
@staticmethod
|
||||||
|
def copy_all(
|
||||||
|
src_conn: sqlite3.Connection,
|
||||||
|
dst_conn: sqlite3.Connection,
|
||||||
|
batch_size: int,
|
||||||
|
) -> None:
|
||||||
|
"""Stream document_meta from src_conn into dst_conn in bounded
|
||||||
|
batches. The *only* sanctioned way to move this table across
|
||||||
|
connections (compact()/migrations) -- an unbounded fetchall here
|
||||||
|
would defeat the same OOM-avoidance the vec0 row copy already relies
|
||||||
|
on. batch_size has no default: forces the call site to think about
|
||||||
|
it (pass COMPACT_BATCH_SIZE)."""
|
||||||
|
cursor = src_conn.execute(
|
||||||
|
"SELECT document_id, modified FROM document_meta",
|
||||||
|
)
|
||||||
|
while batch := cursor.fetchmany(batch_size):
|
||||||
|
DocumentMetaTable.upsert_many(
|
||||||
|
dst_conn,
|
||||||
|
(DocumentMetaRow(r["document_id"], r["modified"]) for r in batch),
|
||||||
|
)
|
||||||
|
|
||||||
|
@staticmethod
|
||||||
|
def all_modified_times(conn: sqlite3.Connection) -> dict[str, str]:
|
||||||
|
"""Full document_id -> modified map, for get_modified_times()'s
|
||||||
|
public API only. One unbounded read by design (existing behavior).
|
||||||
|
Never use this for cross-connection copying; see copy_all()."""
|
||||||
|
return {
|
||||||
|
str(row["document_id"]): str(row["modified"] or "")
|
||||||
|
for row in conn.execute(
|
||||||
|
"SELECT document_id, modified FROM document_meta",
|
||||||
|
)
|
||||||
|
}
|
||||||
|
|
||||||
|
|
||||||
|
class IndexMetaTable:
|
||||||
|
"""Typed accessors over index_meta's key/value rows -- replaces
|
||||||
|
PaperlessSqliteVecVectorStore._meta_get_on/_meta_set_on, which returned
|
||||||
|
untyped str | None regardless of whether the key held an int (dim,
|
||||||
|
schema_version, total_inserts) or a string (embed_model).
|
||||||
|
"""
|
||||||
|
|
||||||
|
@staticmethod
|
||||||
|
def create(conn: sqlite3.Connection) -> None:
|
||||||
|
conn.execute(
|
||||||
|
"CREATE TABLE IF NOT EXISTS index_meta (key TEXT PRIMARY KEY, value TEXT)",
|
||||||
|
)
|
||||||
|
|
||||||
|
@staticmethod
|
||||||
|
def _get(conn: sqlite3.Connection, key: str) -> str | None:
|
||||||
|
row = conn.execute(
|
||||||
|
"SELECT value FROM index_meta WHERE key = ?",
|
||||||
|
(key,),
|
||||||
|
).fetchone()
|
||||||
|
return row["value"] if row else None
|
||||||
|
|
||||||
|
@staticmethod
|
||||||
|
def _set(conn: sqlite3.Connection, key: str, value: str) -> None:
|
||||||
|
conn.execute(
|
||||||
|
"INSERT INTO index_meta (key, value) VALUES (?, ?) "
|
||||||
|
"ON CONFLICT(key) DO UPDATE SET value = excluded.value",
|
||||||
|
(key, value),
|
||||||
|
)
|
||||||
|
|
||||||
|
@staticmethod
|
||||||
|
def get_dim(conn: sqlite3.Connection) -> int | None:
|
||||||
|
value = IndexMetaTable._get(conn, "dim")
|
||||||
|
return int(value) if value is not None else None
|
||||||
|
|
||||||
|
@staticmethod
|
||||||
|
def set_dim(conn: sqlite3.Connection, dim: int) -> None:
|
||||||
|
IndexMetaTable._set(conn, "dim", str(dim))
|
||||||
|
|
||||||
|
@staticmethod
|
||||||
|
def get_embed_model(conn: sqlite3.Connection) -> str | None:
|
||||||
|
return IndexMetaTable._get(conn, "embed_model")
|
||||||
|
|
||||||
|
@staticmethod
|
||||||
|
def set_embed_model(conn: sqlite3.Connection, name: str) -> None:
|
||||||
|
IndexMetaTable._set(conn, "embed_model", name)
|
||||||
|
|
||||||
|
@staticmethod
|
||||||
|
def get_schema_version(conn: sqlite3.Connection) -> int | None:
|
||||||
|
value = IndexMetaTable._get(conn, "schema_version")
|
||||||
|
return int(value) if value is not None else None
|
||||||
|
|
||||||
|
@staticmethod
|
||||||
|
def set_schema_version(conn: sqlite3.Connection, version: int) -> None:
|
||||||
|
IndexMetaTable._set(conn, "schema_version", str(version))
|
||||||
|
|
||||||
|
@staticmethod
|
||||||
|
def get_total_inserts(conn: sqlite3.Connection) -> int:
|
||||||
|
value = IndexMetaTable._get(conn, "total_inserts")
|
||||||
|
return int(value) if value is not None else 0
|
||||||
|
|
||||||
|
@staticmethod
|
||||||
|
def increment_total_inserts(conn: sqlite3.Connection, count: int) -> None:
|
||||||
|
current = IndexMetaTable.get_total_inserts(conn)
|
||||||
|
IndexMetaTable._set(conn, "total_inserts", str(current + count))
|
||||||
|
|
||||||
|
@staticmethod
|
||||||
|
def reset_total_inserts(conn: sqlite3.Connection, count: int) -> None:
|
||||||
|
"""Set total_inserts to an absolute value -- distinct from
|
||||||
|
increment_total_inserts(): used by compact()'s rebuild and by
|
||||||
|
m0001_v1_to_v2 after copying live rows into a fresh file, where
|
||||||
|
total_inserts must become exactly the live row count, not add to
|
||||||
|
whatever the source file's counter held."""
|
||||||
|
IndexMetaTable._set(conn, "total_inserts", str(count))
|
||||||
@@ -1,3 +1,4 @@
|
|||||||
|
import logging
|
||||||
from pathlib import Path
|
from pathlib import Path
|
||||||
from unittest.mock import MagicMock
|
from unittest.mock import MagicMock
|
||||||
from unittest.mock import patch
|
from unittest.mock import patch
|
||||||
@@ -737,6 +738,7 @@ class TestLlmIndexLocking:
|
|||||||
mocker: pytest_mock.MockerFixture,
|
mocker: pytest_mock.MockerFixture,
|
||||||
) -> None:
|
) -> None:
|
||||||
mock_store = MagicMock()
|
mock_store = MagicMock()
|
||||||
|
mock_store.has_pending_migration.return_value = False
|
||||||
mocker.patch(
|
mocker.patch(
|
||||||
"paperless_ai.indexing.write_store",
|
"paperless_ai.indexing.write_store",
|
||||||
return_value=mocker.MagicMock(
|
return_value=mocker.MagicMock(
|
||||||
@@ -757,12 +759,45 @@ class TestLlmIndexLocking:
|
|||||||
|
|
||||||
mock_store.upsert_document.assert_called_once()
|
mock_store.upsert_document.assert_called_once()
|
||||||
|
|
||||||
|
def test_add_or_update_document_skips_write_when_reembed_pending(
|
||||||
|
self,
|
||||||
|
temp_llm_index_dir: Path,
|
||||||
|
mock_embed_model: FakeEmbedding,
|
||||||
|
mocker: pytest_mock.MockerFixture,
|
||||||
|
) -> None:
|
||||||
|
"""A pending re-embed migration must block the incremental write,
|
||||||
|
not let it proceed against a schema that just changed underneath it.
|
||||||
|
"""
|
||||||
|
mock_store = MagicMock()
|
||||||
|
mock_store.has_pending_migration.return_value = True
|
||||||
|
mock_store.check_and_run_migrations.return_value = True
|
||||||
|
mocker.patch(
|
||||||
|
"paperless_ai.indexing.write_store",
|
||||||
|
return_value=mocker.MagicMock(
|
||||||
|
__enter__=mocker.MagicMock(return_value=mock_store),
|
||||||
|
__exit__=mocker.MagicMock(return_value=False),
|
||||||
|
),
|
||||||
|
)
|
||||||
|
mock_node = MagicMock()
|
||||||
|
mock_node.get_content.return_value = "fake node text"
|
||||||
|
mocker.patch(
|
||||||
|
"paperless_ai.indexing.build_document_node",
|
||||||
|
return_value=[mock_node],
|
||||||
|
)
|
||||||
|
|
||||||
|
doc = MagicMock(spec=Document)
|
||||||
|
doc.id = 1
|
||||||
|
indexing.llm_index_add_or_update_document(doc)
|
||||||
|
|
||||||
|
mock_store.upsert_document.assert_not_called()
|
||||||
|
|
||||||
def test_remove_document_uses_write_store(
|
def test_remove_document_uses_write_store(
|
||||||
self,
|
self,
|
||||||
temp_llm_index_dir: Path,
|
temp_llm_index_dir: Path,
|
||||||
mocker: pytest_mock.MockerFixture,
|
mocker: pytest_mock.MockerFixture,
|
||||||
) -> None:
|
) -> None:
|
||||||
mock_store = MagicMock()
|
mock_store = MagicMock()
|
||||||
|
mock_store.has_pending_migration.return_value = False
|
||||||
mocker.patch(
|
mocker.patch(
|
||||||
"paperless_ai.indexing.write_store",
|
"paperless_ai.indexing.write_store",
|
||||||
return_value=mocker.MagicMock(
|
return_value=mocker.MagicMock(
|
||||||
@@ -777,6 +812,31 @@ class TestLlmIndexLocking:
|
|||||||
|
|
||||||
mock_store.delete.assert_called_once_with("1")
|
mock_store.delete.assert_called_once_with("1")
|
||||||
|
|
||||||
|
def test_remove_document_skips_write_when_reembed_pending(
|
||||||
|
self,
|
||||||
|
temp_llm_index_dir: Path,
|
||||||
|
mocker: pytest_mock.MockerFixture,
|
||||||
|
) -> None:
|
||||||
|
"""A pending re-embed migration must block the delete too, for the
|
||||||
|
same consistency reason as the incremental-update path.
|
||||||
|
"""
|
||||||
|
mock_store = MagicMock()
|
||||||
|
mock_store.has_pending_migration.return_value = True
|
||||||
|
mock_store.check_and_run_migrations.return_value = True
|
||||||
|
mocker.patch(
|
||||||
|
"paperless_ai.indexing.write_store",
|
||||||
|
return_value=mocker.MagicMock(
|
||||||
|
__enter__=mocker.MagicMock(return_value=mock_store),
|
||||||
|
__exit__=mocker.MagicMock(return_value=False),
|
||||||
|
),
|
||||||
|
)
|
||||||
|
|
||||||
|
doc = MagicMock(spec=Document)
|
||||||
|
doc.id = 1
|
||||||
|
indexing.llm_index_remove_document(doc)
|
||||||
|
|
||||||
|
mock_store.delete.assert_not_called()
|
||||||
|
|
||||||
def test_update_llm_index_rebuild_uses_write_store(
|
def test_update_llm_index_rebuild_uses_write_store(
|
||||||
self,
|
self,
|
||||||
temp_llm_index_dir: Path,
|
temp_llm_index_dir: Path,
|
||||||
@@ -849,6 +909,76 @@ class TestVectorStoreIndexing:
|
|||||||
assert rows >= 1
|
assert rows >= 1
|
||||||
|
|
||||||
|
|
||||||
|
class TestLlmIndexMigrate:
|
||||||
|
def test_noop_when_ai_disabled(self, mocker: pytest_mock.MockerFixture) -> None:
|
||||||
|
"""
|
||||||
|
GIVEN:
|
||||||
|
- AI/LLM index support is disabled in configuration
|
||||||
|
WHEN:
|
||||||
|
- llm_index_migrate() is called
|
||||||
|
THEN:
|
||||||
|
- No store is opened and no migration check runs
|
||||||
|
"""
|
||||||
|
mocker.patch(
|
||||||
|
"paperless_ai.indexing.AIConfig",
|
||||||
|
return_value=mocker.Mock(llm_index_enabled=False),
|
||||||
|
)
|
||||||
|
write_store_mock = mocker.patch("paperless_ai.indexing.write_store")
|
||||||
|
indexing.llm_index_migrate()
|
||||||
|
write_store_mock.assert_not_called()
|
||||||
|
|
||||||
|
def test_runs_pending_migration_when_enabled(
|
||||||
|
self,
|
||||||
|
mocker: pytest_mock.MockerFixture,
|
||||||
|
) -> None:
|
||||||
|
"""
|
||||||
|
GIVEN:
|
||||||
|
- AI/LLM index support is enabled
|
||||||
|
WHEN:
|
||||||
|
- llm_index_migrate() is called
|
||||||
|
THEN:
|
||||||
|
- The store is opened for write and a migration check runs
|
||||||
|
"""
|
||||||
|
mocker.patch(
|
||||||
|
"paperless_ai.indexing.AIConfig",
|
||||||
|
return_value=mocker.Mock(llm_index_enabled=True),
|
||||||
|
)
|
||||||
|
store_mock = mocker.MagicMock()
|
||||||
|
store_mock.has_pending_migration.return_value = False
|
||||||
|
write_store_cm = mocker.patch("paperless_ai.indexing.write_store")
|
||||||
|
write_store_cm.return_value.__enter__.return_value = store_mock
|
||||||
|
indexing.llm_index_migrate()
|
||||||
|
store_mock.has_pending_migration.assert_called_once()
|
||||||
|
|
||||||
|
def test_logs_warning_when_reembed_needed(
|
||||||
|
self,
|
||||||
|
mocker: pytest_mock.MockerFixture,
|
||||||
|
caplog: pytest.LogCaptureFixture,
|
||||||
|
) -> None:
|
||||||
|
"""
|
||||||
|
GIVEN:
|
||||||
|
- AI/LLM index support is enabled
|
||||||
|
- A pending migration requires re-embedding
|
||||||
|
WHEN:
|
||||||
|
- llm_index_migrate() is called
|
||||||
|
THEN:
|
||||||
|
- A warning directs the operator to run a manual rebuild, since
|
||||||
|
this automatic check must never re-embed on its own
|
||||||
|
"""
|
||||||
|
mocker.patch(
|
||||||
|
"paperless_ai.indexing.AIConfig",
|
||||||
|
return_value=mocker.Mock(llm_index_enabled=True),
|
||||||
|
)
|
||||||
|
store_mock = mocker.MagicMock()
|
||||||
|
store_mock.has_pending_migration.return_value = True
|
||||||
|
store_mock.check_and_run_migrations.return_value = True
|
||||||
|
write_store_cm = mocker.patch("paperless_ai.indexing.write_store")
|
||||||
|
write_store_cm.return_value.__enter__.return_value = store_mock
|
||||||
|
with caplog.at_level(logging.WARNING, logger="paperless_ai.indexing"):
|
||||||
|
indexing.llm_index_migrate()
|
||||||
|
assert "requires re-embedding" in caplog.text
|
||||||
|
|
||||||
|
|
||||||
@pytest.mark.django_db
|
@pytest.mark.django_db
|
||||||
class TestQuerySimilarDocuments:
|
class TestQuerySimilarDocuments:
|
||||||
def test_query_similar_documents_respects_allowed_ids(
|
def test_query_similar_documents_respects_allowed_ids(
|
||||||
|
|||||||
@@ -0,0 +1,306 @@
|
|||||||
|
import sqlite3
|
||||||
|
from collections.abc import Generator
|
||||||
|
|
||||||
|
import pytest
|
||||||
|
|
||||||
|
from paperless_ai.tables import ChunkRow
|
||||||
|
from paperless_ai.tables import DocumentChunksTable
|
||||||
|
from paperless_ai.tables import DocumentMetaRow
|
||||||
|
from paperless_ai.tables import DocumentMetaTable
|
||||||
|
from paperless_ai.tables import IndexMetaTable
|
||||||
|
|
||||||
|
|
||||||
|
@pytest.fixture
|
||||||
|
def conn() -> Generator[sqlite3.Connection, None, None]:
|
||||||
|
connection = sqlite3.connect(":memory:")
|
||||||
|
connection.row_factory = sqlite3.Row
|
||||||
|
try:
|
||||||
|
yield connection
|
||||||
|
finally:
|
||||||
|
connection.close()
|
||||||
|
|
||||||
|
|
||||||
|
class TestDocumentChunksTable:
|
||||||
|
def test_create_is_idempotent(self, conn: sqlite3.Connection) -> None:
|
||||||
|
"""
|
||||||
|
GIVEN:
|
||||||
|
- A bare sqlite3 connection
|
||||||
|
WHEN:
|
||||||
|
- create() is called, a row is inserted, then create() is called again
|
||||||
|
THEN:
|
||||||
|
- No error is raised and the row survives uncorrupted
|
||||||
|
"""
|
||||||
|
DocumentChunksTable.create(conn)
|
||||||
|
DocumentChunksTable.insert_many(conn, [ChunkRow("c1", 1)])
|
||||||
|
DocumentChunksTable.create(conn)
|
||||||
|
assert DocumentChunksTable.chunk_ids_for_document(conn, 1) == ["c1"]
|
||||||
|
|
||||||
|
def test_insert_many_then_lookup_by_document_id(
|
||||||
|
self,
|
||||||
|
conn: sqlite3.Connection,
|
||||||
|
) -> None:
|
||||||
|
"""
|
||||||
|
GIVEN:
|
||||||
|
- An empty document_chunks table
|
||||||
|
WHEN:
|
||||||
|
- Two chunks for document 1 and one for document 2 are inserted
|
||||||
|
THEN:
|
||||||
|
- chunk_ids_for_document returns exactly the matching chunk ids
|
||||||
|
"""
|
||||||
|
DocumentChunksTable.create(conn)
|
||||||
|
DocumentChunksTable.insert_many(
|
||||||
|
conn,
|
||||||
|
[ChunkRow("c1", 1), ChunkRow("c2", 1), ChunkRow("c3", 2)],
|
||||||
|
)
|
||||||
|
assert sorted(DocumentChunksTable.chunk_ids_for_document(conn, 1)) == [
|
||||||
|
"c1",
|
||||||
|
"c2",
|
||||||
|
]
|
||||||
|
assert DocumentChunksTable.chunk_ids_for_document(conn, 2) == ["c3"]
|
||||||
|
assert DocumentChunksTable.chunk_ids_for_document(conn, 999) == []
|
||||||
|
|
||||||
|
def test_delete_for_document_removes_only_that_document(
|
||||||
|
self,
|
||||||
|
conn: sqlite3.Connection,
|
||||||
|
) -> None:
|
||||||
|
"""
|
||||||
|
GIVEN:
|
||||||
|
- Chunks for two different documents
|
||||||
|
WHEN:
|
||||||
|
- delete_for_document() is called for one of them
|
||||||
|
THEN:
|
||||||
|
- Only that document's chunks are removed
|
||||||
|
"""
|
||||||
|
DocumentChunksTable.create(conn)
|
||||||
|
DocumentChunksTable.insert_many(
|
||||||
|
conn,
|
||||||
|
[ChunkRow("c1", 1), ChunkRow("c2", 2)],
|
||||||
|
)
|
||||||
|
DocumentChunksTable.delete_for_document(conn, 1)
|
||||||
|
assert DocumentChunksTable.chunk_ids_for_document(conn, 1) == []
|
||||||
|
assert DocumentChunksTable.chunk_ids_for_document(conn, 2) == ["c2"]
|
||||||
|
|
||||||
|
def test_delete_all_clears_every_row(self, conn: sqlite3.Connection) -> None:
|
||||||
|
"""
|
||||||
|
GIVEN:
|
||||||
|
- Chunks for multiple documents
|
||||||
|
WHEN:
|
||||||
|
- delete_all() is called
|
||||||
|
THEN:
|
||||||
|
- count() returns 0
|
||||||
|
"""
|
||||||
|
DocumentChunksTable.create(conn)
|
||||||
|
DocumentChunksTable.insert_many(
|
||||||
|
conn,
|
||||||
|
[ChunkRow("c1", 1), ChunkRow("c2", 2)],
|
||||||
|
)
|
||||||
|
DocumentChunksTable.delete_all(conn)
|
||||||
|
assert DocumentChunksTable.count(conn) == 0
|
||||||
|
|
||||||
|
def test_count_reflects_live_rows(self, conn: sqlite3.Connection) -> None:
|
||||||
|
"""
|
||||||
|
GIVEN:
|
||||||
|
- An empty document_chunks table
|
||||||
|
WHEN:
|
||||||
|
- Rows are inserted then one document's rows are deleted
|
||||||
|
THEN:
|
||||||
|
- count() reflects the remaining row count
|
||||||
|
"""
|
||||||
|
DocumentChunksTable.create(conn)
|
||||||
|
DocumentChunksTable.insert_many(
|
||||||
|
conn,
|
||||||
|
[ChunkRow("c1", 1), ChunkRow("c2", 1), ChunkRow("c3", 2)],
|
||||||
|
)
|
||||||
|
assert DocumentChunksTable.count(conn) == 3
|
||||||
|
DocumentChunksTable.delete_for_document(conn, 1)
|
||||||
|
assert DocumentChunksTable.count(conn) == 1
|
||||||
|
|
||||||
|
|
||||||
|
class TestDocumentMetaTable:
|
||||||
|
def test_upsert_many_then_all_modified_times(
|
||||||
|
self,
|
||||||
|
conn: sqlite3.Connection,
|
||||||
|
) -> None:
|
||||||
|
"""
|
||||||
|
GIVEN:
|
||||||
|
- An empty document_meta table
|
||||||
|
WHEN:
|
||||||
|
- Two documents' modified timestamps are upserted
|
||||||
|
THEN:
|
||||||
|
- all_modified_times() returns both, keyed by str(document_id)
|
||||||
|
"""
|
||||||
|
DocumentMetaTable.create(conn)
|
||||||
|
DocumentMetaTable.upsert_many(
|
||||||
|
conn,
|
||||||
|
[
|
||||||
|
DocumentMetaRow(1, "2026-01-01T00:00:00"),
|
||||||
|
DocumentMetaRow(2, "2026-02-02T00:00:00"),
|
||||||
|
],
|
||||||
|
)
|
||||||
|
assert DocumentMetaTable.all_modified_times(conn) == {
|
||||||
|
"1": "2026-01-01T00:00:00",
|
||||||
|
"2": "2026-02-02T00:00:00",
|
||||||
|
}
|
||||||
|
|
||||||
|
def test_upsert_many_overwrites_existing_value(
|
||||||
|
self,
|
||||||
|
conn: sqlite3.Connection,
|
||||||
|
) -> None:
|
||||||
|
"""
|
||||||
|
GIVEN:
|
||||||
|
- A document_meta row for document 1
|
||||||
|
WHEN:
|
||||||
|
- upsert_many() is called again with a new modified value for
|
||||||
|
the same document_id
|
||||||
|
THEN:
|
||||||
|
- The stored value is replaced, not duplicated
|
||||||
|
"""
|
||||||
|
DocumentMetaTable.create(conn)
|
||||||
|
DocumentMetaTable.upsert_many(conn, [DocumentMetaRow(1, "old")])
|
||||||
|
DocumentMetaTable.upsert_many(conn, [DocumentMetaRow(1, "new")])
|
||||||
|
assert DocumentMetaTable.all_modified_times(conn) == {"1": "new"}
|
||||||
|
|
||||||
|
def test_delete_for_document_removes_only_that_row(
|
||||||
|
self,
|
||||||
|
conn: sqlite3.Connection,
|
||||||
|
) -> None:
|
||||||
|
"""
|
||||||
|
GIVEN:
|
||||||
|
- document_meta rows for two documents
|
||||||
|
WHEN:
|
||||||
|
- delete_for_document() is called for one of them
|
||||||
|
THEN:
|
||||||
|
- Only that document's row is removed
|
||||||
|
"""
|
||||||
|
DocumentMetaTable.create(conn)
|
||||||
|
DocumentMetaTable.upsert_many(
|
||||||
|
conn,
|
||||||
|
[DocumentMetaRow(1, "a"), DocumentMetaRow(2, "b")],
|
||||||
|
)
|
||||||
|
DocumentMetaTable.delete_for_document(conn, 1)
|
||||||
|
assert DocumentMetaTable.all_modified_times(conn) == {"2": "b"}
|
||||||
|
|
||||||
|
def test_delete_all_clears_every_row(self, conn: sqlite3.Connection) -> None:
|
||||||
|
"""
|
||||||
|
GIVEN:
|
||||||
|
- document_meta rows for multiple documents
|
||||||
|
WHEN:
|
||||||
|
- delete_all() is called
|
||||||
|
THEN:
|
||||||
|
- all_modified_times() returns an empty dict
|
||||||
|
"""
|
||||||
|
DocumentMetaTable.create(conn)
|
||||||
|
DocumentMetaTable.upsert_many(
|
||||||
|
conn,
|
||||||
|
[DocumentMetaRow(1, "a"), DocumentMetaRow(2, "b")],
|
||||||
|
)
|
||||||
|
DocumentMetaTable.delete_all(conn)
|
||||||
|
assert DocumentMetaTable.all_modified_times(conn) == {}
|
||||||
|
|
||||||
|
def test_copy_all_streams_every_row_to_destination(
|
||||||
|
self,
|
||||||
|
conn: sqlite3.Connection,
|
||||||
|
) -> None:
|
||||||
|
"""
|
||||||
|
GIVEN:
|
||||||
|
- A source connection with document_meta rows for 5 documents
|
||||||
|
- A separate, empty destination connection
|
||||||
|
WHEN:
|
||||||
|
- copy_all() is called with a batch size smaller than the row
|
||||||
|
count, forcing multiple fetchmany() cycles
|
||||||
|
THEN:
|
||||||
|
- Every row is present on the destination connection
|
||||||
|
"""
|
||||||
|
DocumentMetaTable.create(conn)
|
||||||
|
DocumentMetaTable.upsert_many(
|
||||||
|
conn,
|
||||||
|
[DocumentMetaRow(i, f"modified-{i}") for i in range(5)],
|
||||||
|
)
|
||||||
|
dst_conn = sqlite3.connect(":memory:")
|
||||||
|
dst_conn.row_factory = sqlite3.Row
|
||||||
|
try:
|
||||||
|
DocumentMetaTable.create(dst_conn)
|
||||||
|
DocumentMetaTable.copy_all(conn, dst_conn, batch_size=2)
|
||||||
|
assert DocumentMetaTable.all_modified_times(dst_conn) == {
|
||||||
|
str(i): f"modified-{i}" for i in range(5)
|
||||||
|
}
|
||||||
|
finally:
|
||||||
|
dst_conn.close()
|
||||||
|
|
||||||
|
|
||||||
|
class TestIndexMetaTable:
|
||||||
|
@pytest.mark.parametrize(
|
||||||
|
("setter_name", "getter_name", "value"),
|
||||||
|
[
|
||||||
|
("set_dim", "get_dim", 384),
|
||||||
|
("set_embed_model", "get_embed_model", "model-a"),
|
||||||
|
("set_schema_version", "get_schema_version", 2),
|
||||||
|
],
|
||||||
|
)
|
||||||
|
def test_typed_accessor_roundtrip(
|
||||||
|
self,
|
||||||
|
conn: sqlite3.Connection,
|
||||||
|
setter_name: str,
|
||||||
|
getter_name: str,
|
||||||
|
value: int | str,
|
||||||
|
) -> None:
|
||||||
|
"""
|
||||||
|
GIVEN:
|
||||||
|
- An empty index_meta table
|
||||||
|
WHEN:
|
||||||
|
- A typed accessor's setter is called then the getter is read back
|
||||||
|
THEN:
|
||||||
|
- The same value is returned, correctly typed (int or str)
|
||||||
|
"""
|
||||||
|
IndexMetaTable.create(conn)
|
||||||
|
getter = getattr(IndexMetaTable, getter_name)
|
||||||
|
setter = getattr(IndexMetaTable, setter_name)
|
||||||
|
assert getter(conn) is None
|
||||||
|
setter(conn, value)
|
||||||
|
assert getter(conn) == value
|
||||||
|
|
||||||
|
def test_total_inserts_starts_at_zero(self, conn: sqlite3.Connection) -> None:
|
||||||
|
"""
|
||||||
|
GIVEN:
|
||||||
|
- An empty index_meta table
|
||||||
|
WHEN:
|
||||||
|
- get_total_inserts() is read before anything is set
|
||||||
|
THEN:
|
||||||
|
- 0 is returned
|
||||||
|
"""
|
||||||
|
IndexMetaTable.create(conn)
|
||||||
|
assert IndexMetaTable.get_total_inserts(conn) == 0
|
||||||
|
|
||||||
|
def test_increment_total_inserts_accumulates(
|
||||||
|
self,
|
||||||
|
conn: sqlite3.Connection,
|
||||||
|
) -> None:
|
||||||
|
"""
|
||||||
|
GIVEN:
|
||||||
|
- An empty index_meta table
|
||||||
|
WHEN:
|
||||||
|
- increment_total_inserts() is called twice
|
||||||
|
THEN:
|
||||||
|
- get_total_inserts() returns the running sum
|
||||||
|
"""
|
||||||
|
IndexMetaTable.create(conn)
|
||||||
|
IndexMetaTable.increment_total_inserts(conn, 5)
|
||||||
|
IndexMetaTable.increment_total_inserts(conn, 3)
|
||||||
|
assert IndexMetaTable.get_total_inserts(conn) == 8
|
||||||
|
|
||||||
|
def test_reset_total_inserts_sets_absolute_value(
|
||||||
|
self,
|
||||||
|
conn: sqlite3.Connection,
|
||||||
|
) -> None:
|
||||||
|
"""
|
||||||
|
GIVEN:
|
||||||
|
- A total_inserts counter already at a high value
|
||||||
|
WHEN:
|
||||||
|
- reset_total_inserts() is called with a lower value
|
||||||
|
THEN:
|
||||||
|
- get_total_inserts() returns exactly that value, not a sum
|
||||||
|
"""
|
||||||
|
IndexMetaTable.create(conn)
|
||||||
|
IndexMetaTable.increment_total_inserts(conn, 100)
|
||||||
|
IndexMetaTable.reset_total_inserts(conn, 7)
|
||||||
|
assert IndexMetaTable.get_total_inserts(conn) == 7
|
||||||
@@ -9,11 +9,11 @@ from llama_index.core.vector_stores.types import MetadataFilter
|
|||||||
from llama_index.core.vector_stores.types import MetadataFilters
|
from llama_index.core.vector_stores.types import MetadataFilters
|
||||||
from llama_index.core.vector_stores.types import VectorStoreQuery
|
from llama_index.core.vector_stores.types import VectorStoreQuery
|
||||||
|
|
||||||
|
from paperless_ai.migrations import MIGRATIONS
|
||||||
|
from paperless_ai.migrations import Migration
|
||||||
from paperless_ai.vector_store import DB_FILENAME
|
from paperless_ai.vector_store import DB_FILENAME
|
||||||
from paperless_ai.vector_store import DEFAULT_TABLE_NAME
|
from paperless_ai.vector_store import DEFAULT_TABLE_NAME
|
||||||
from paperless_ai.vector_store import MIGRATIONS
|
|
||||||
from paperless_ai.vector_store import SCHEMA_VERSION
|
from paperless_ai.vector_store import SCHEMA_VERSION
|
||||||
from paperless_ai.vector_store import Migration
|
|
||||||
from paperless_ai.vector_store import PaperlessSqliteVecVectorStore
|
from paperless_ai.vector_store import PaperlessSqliteVecVectorStore
|
||||||
from paperless_ai.vector_store import _build_where
|
from paperless_ai.vector_store import _build_where
|
||||||
|
|
||||||
@@ -646,3 +646,50 @@ class TestMigrations:
|
|||||||
|
|
||||||
assert result is True
|
assert result is True
|
||||||
assert self._schema_version(store) == 2
|
assert self._schema_version(store) == 2
|
||||||
|
|
||||||
|
def test_has_pending_migration_false_when_no_table(
|
||||||
|
self,
|
||||||
|
store: PaperlessSqliteVecVectorStore,
|
||||||
|
) -> None:
|
||||||
|
"""
|
||||||
|
GIVEN:
|
||||||
|
- A vector store with no table created yet
|
||||||
|
WHEN:
|
||||||
|
- has_pending_migration() is checked
|
||||||
|
THEN:
|
||||||
|
- False is returned (nothing to migrate before anything exists)
|
||||||
|
"""
|
||||||
|
assert store.has_pending_migration() is False
|
||||||
|
|
||||||
|
def test_has_pending_migration_false_at_current_version(
|
||||||
|
self,
|
||||||
|
store: PaperlessSqliteVecVectorStore,
|
||||||
|
) -> None:
|
||||||
|
"""
|
||||||
|
GIVEN:
|
||||||
|
- A store at the current SCHEMA_VERSION
|
||||||
|
WHEN:
|
||||||
|
- has_pending_migration() is checked
|
||||||
|
THEN:
|
||||||
|
- False is returned
|
||||||
|
"""
|
||||||
|
store.add([make_node("a1", "1")])
|
||||||
|
assert store.has_pending_migration() is False
|
||||||
|
|
||||||
|
def test_has_pending_migration_true_when_behind(
|
||||||
|
self,
|
||||||
|
store: PaperlessSqliteVecVectorStore,
|
||||||
|
) -> None:
|
||||||
|
"""
|
||||||
|
GIVEN:
|
||||||
|
- A store whose schema_version has been forced behind SCHEMA_VERSION
|
||||||
|
WHEN:
|
||||||
|
- has_pending_migration() is checked
|
||||||
|
THEN:
|
||||||
|
- True is returned
|
||||||
|
"""
|
||||||
|
store.add([make_node("a1", "1")])
|
||||||
|
store.client.execute(
|
||||||
|
"UPDATE index_meta SET value = '0' WHERE key = 'schema_version'",
|
||||||
|
)
|
||||||
|
assert store.has_pending_migration() is True
|
||||||
|
|||||||
@@ -2,16 +2,12 @@ import json
|
|||||||
import logging
|
import logging
|
||||||
import sqlite3
|
import sqlite3
|
||||||
import struct
|
import struct
|
||||||
from collections.abc import Callable
|
|
||||||
from collections.abc import Iterator
|
from collections.abc import Iterator
|
||||||
from collections.abc import Sequence
|
from collections.abc import Sequence
|
||||||
from contextlib import contextmanager
|
from contextlib import contextmanager
|
||||||
from dataclasses import dataclass
|
|
||||||
from dataclasses import field
|
|
||||||
from pathlib import Path
|
from pathlib import Path
|
||||||
from types import TracebackType
|
from types import TracebackType
|
||||||
from typing import Any
|
from typing import Any
|
||||||
from typing import Literal
|
|
||||||
|
|
||||||
import sqlite_vec
|
import sqlite_vec
|
||||||
from llama_index.core.bridge.pydantic import PrivateAttr
|
from llama_index.core.bridge.pydantic import PrivateAttr
|
||||||
@@ -26,6 +22,9 @@ from llama_index.core.vector_stores.types import VectorStoreQueryResult
|
|||||||
from llama_index.core.vector_stores.utils import metadata_dict_to_node
|
from llama_index.core.vector_stores.utils import metadata_dict_to_node
|
||||||
from llama_index.core.vector_stores.utils import node_to_metadata_dict
|
from llama_index.core.vector_stores.utils import node_to_metadata_dict
|
||||||
|
|
||||||
|
from paperless_ai.migrations import MIGRATIONS
|
||||||
|
from paperless_ai.migrations import Migration
|
||||||
|
|
||||||
logger = logging.getLogger("paperless_ai.vector_store")
|
logger = logging.getLogger("paperless_ai.vector_store")
|
||||||
|
|
||||||
DB_FILENAME = "llmindex.db"
|
DB_FILENAME = "llmindex.db"
|
||||||
@@ -53,38 +52,6 @@ COMPACT_BATCH_SIZE = 500
|
|||||||
_FILTER_COLUMNS = frozenset({"document_id", "modified"})
|
_FILTER_COLUMNS = frozenset({"document_id", "modified"})
|
||||||
|
|
||||||
|
|
||||||
@dataclass
|
|
||||||
class Migration:
|
|
||||||
"""A schema migration for the sqlite-vec vector store.
|
|
||||||
|
|
||||||
kind="structural": rows are copied into a new-schema file with no
|
|
||||||
re-embedding needed. Supply ``apply(src_conn, dst_conn, dim)`` which
|
|
||||||
must create the vec0 table in ``dst_conn``, copy all rows from
|
|
||||||
``src_conn``, and write ``dim`` / ``embed_model`` / ``total_inserts`` to
|
|
||||||
``dst_conn``'s ``index_meta``. ``schema_version`` is written by the
|
|
||||||
migration runner after ``apply`` returns.
|
|
||||||
|
|
||||||
kind="re-embed": the new schema requires fresh embeddings.
|
|
||||||
``check_and_run_migrations()`` returns True when it encounters one of
|
|
||||||
these so the caller can force a full rebuild (which recreates the table
|
|
||||||
at the current SCHEMA_VERSION).
|
|
||||||
"""
|
|
||||||
|
|
||||||
from_version: int
|
|
||||||
to_version: int
|
|
||||||
kind: Literal["structural", "re-embed"]
|
|
||||||
description: str
|
|
||||||
apply: Callable[[sqlite3.Connection, sqlite3.Connection, int], None] | None = field(
|
|
||||||
default=None,
|
|
||||||
repr=False,
|
|
||||||
)
|
|
||||||
|
|
||||||
|
|
||||||
# Registry of all schema migrations in order. Empty at v1 -- this is the
|
|
||||||
# baseline. Add entries here (and bump SCHEMA_VERSION) when the schema changes.
|
|
||||||
MIGRATIONS: list[Migration] = []
|
|
||||||
|
|
||||||
|
|
||||||
def _pack(embedding: Sequence[float]) -> bytes:
|
def _pack(embedding: Sequence[float]) -> bytes:
|
||||||
return struct.pack(f"{len(embedding)}f", *embedding)
|
return struct.pack(f"{len(embedding)}f", *embedding)
|
||||||
|
|
||||||
@@ -551,6 +518,31 @@ class PaperlessSqliteVecVectorStore(BasePydanticVectorStore):
|
|||||||
Path(compact_path).replace(db_path)
|
Path(compact_path).replace(db_path)
|
||||||
self._conn = self._open_connection(db_path)
|
self._conn = self._open_connection(db_path)
|
||||||
|
|
||||||
|
def _stored_schema_version(self) -> int | None:
|
||||||
|
"""The schema_version recorded in index_meta, or None if no table
|
||||||
|
exists. A missing key (a store predating version tracking) is
|
||||||
|
treated as SCHEMA_VERSION -- i.e. already current -- since no
|
||||||
|
migration in MIGRATIONS targets a version before tracking began.
|
||||||
|
"""
|
||||||
|
if not self.table_exists():
|
||||||
|
return None
|
||||||
|
raw = self._meta_get("schema_version")
|
||||||
|
return int(raw) if raw is not None else SCHEMA_VERSION
|
||||||
|
|
||||||
|
def has_pending_migration(self) -> bool:
|
||||||
|
"""Cheaply check whether a migration is pending, with no exclusive
|
||||||
|
access needed -- just a metadata read under the connection callers
|
||||||
|
already hold via the write FileLock.
|
||||||
|
|
||||||
|
Callers should only pay for check_and_run_migrations()'s exclusive
|
||||||
|
access (a structural migration's file swap must not run while
|
||||||
|
readers are active) when this returns True, so that the common
|
||||||
|
case -- already at SCHEMA_VERSION -- never contends with readers
|
||||||
|
or a concurrent compaction.
|
||||||
|
"""
|
||||||
|
current = self._stored_schema_version()
|
||||||
|
return current is not None and current < SCHEMA_VERSION
|
||||||
|
|
||||||
def check_and_run_migrations(self) -> bool:
|
def check_and_run_migrations(self) -> bool:
|
||||||
"""Apply any pending schema migrations to the store.
|
"""Apply any pending schema migrations to the store.
|
||||||
|
|
||||||
@@ -559,15 +551,13 @@ class PaperlessSqliteVecVectorStore(BasePydanticVectorStore):
|
|||||||
this method returns True when one is encountered so the caller can
|
this method returns True when one is encountered so the caller can
|
||||||
force a full rebuild (which recreates the table at SCHEMA_VERSION).
|
force a full rebuild (which recreates the table at SCHEMA_VERSION).
|
||||||
|
|
||||||
Must be called under the write FileLock. No-op when the table does
|
Must be called under the write FileLock, with readers excluded (see
|
||||||
not exist or is already at SCHEMA_VERSION.
|
has_pending_migration() for a cheap pre-check that avoids paying for
|
||||||
|
that exclusion in the common case). No-op when the table does not
|
||||||
|
exist or is already at SCHEMA_VERSION.
|
||||||
"""
|
"""
|
||||||
if not self.table_exists():
|
current = self._stored_schema_version()
|
||||||
return False
|
if current is None or current >= SCHEMA_VERSION:
|
||||||
|
|
||||||
raw = self._meta_get("schema_version")
|
|
||||||
current = int(raw) if raw is not None else SCHEMA_VERSION
|
|
||||||
if current >= SCHEMA_VERSION:
|
|
||||||
return False
|
return False
|
||||||
|
|
||||||
pending = sorted(
|
pending = sorted(
|
||||||
@@ -579,7 +569,7 @@ class PaperlessSqliteVecVectorStore(BasePydanticVectorStore):
|
|||||||
if migration.kind == "re-embed":
|
if migration.kind == "re-embed":
|
||||||
logger.warning(
|
logger.warning(
|
||||||
"LLM index schema v%d -> v%d requires re-embedding (%s); "
|
"LLM index schema v%d -> v%d requires re-embedding (%s); "
|
||||||
"forcing full rebuild.",
|
"the caller must force a rebuild.",
|
||||||
migration.from_version,
|
migration.from_version,
|
||||||
migration.to_version,
|
migration.to_version,
|
||||||
migration.description,
|
migration.description,
|
||||||
|
|||||||
Reference in New Issue
Block a user