Skip to content

Commit 4e6baa8

Browse files
committed
documentation update
1 parent 7a95379 commit 4e6baa8

File tree

1 file changed

+9
-4
lines changed

1 file changed

+9
-4
lines changed

docs/content.rst

Lines changed: 9 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -55,7 +55,7 @@ or
5555
5656
5757
58-
indexed-fields
58+
Indexed Fields
5959
^^^^^^^^^^^^^^^^^
6060

6161
Get a list of all the indexed metadata fields within the Preservica search engine. This includes the default
@@ -70,13 +70,18 @@ xip.* fields and any custom indexes which have been created through custom index
7070
7171
Full Text Index
7272
^^^^^^^^^^^^^^^^^
73+
If a document contains text such as a PDF or a Word document or it has been `OCR'd <https://en.wikipedia.org/wiki/Optical_character_recognition_>`_
74+
the full text index will contain the extracted text.
7375

74-
If a document has been `OCR'd <https://en.wikipedia.org/wiki/Optical_character_recognition_>`_ the the full text index will
75-
contain the extracted text. To extract the value of the full text index for an Asset use the following call:
76+
To extract the value of the full text index for an Asset use the following call:
7677

7778
.. code-block:: python
7879
79-
text: str = client.full_text("48c79abd-01f3-4b77-8132-546a76e0d337")
80+
from pyPreservica import *
81+
82+
content = ContentAPI()
83+
84+
text: str = content.full_text("48c79abd-01f3-4b77-8132-546a76e0d337")
8085
8186
The reference supplied must be a valid Asset reference.
8287

0 commit comments

Comments
 (0)