paradizelost/paperless-ngx
1
0
Fork 0
mirror of https://github.com/paperless-ngx/paperless-ngx.git synced 2025-08-22 01:01:04 +00:00
Code Issues Packages Projects Releases Wiki Activity

moved the documentation of the config

Browse Source 
to the actual docs.
This commit is contained in:
Jonas Winkler
2020-11-19 13:18:57 +01:00
parent 07e2ff0c2e
commit d1f9f456bb
11 changed files with 419 additions and 297 deletions
Download Patch File Download Diff File Expand all files Collapse all files

5
docs/api.rst
View File

@@ -91,6 +91,7 @@ Result object:
"document": {
}
}
* ``id``: the primary key of the found document
* ``highlights``: an object containing parseable highlights for the result.
@@ -109,7 +110,7 @@ Each fragment contains a list of strings, and some of them are marked as a highl
.. code:: json
"highlights": [
[
[
{"text": "This is a sample text with a "},
{"text": "highlighted", "term": 0},
@@ -120,6 +121,8 @@ Each fragment contains a list of strings, and some of them are marked as a highl
{"text": " fragment with a highlight."}
]
]
When ``term`` is present within a string, the word within ``text`` should be highlighted.
The term index groups multiple matches together and words with the same index