Creating an indexed file
If you need to index a file for semantic search just pass theindex: true
parameter when creating the file.
Supported file formats
The following file formats are supported for indexing:Format | File Extension | MIME Type |
---|---|---|
.pdf | application/pdf | |
HTML | .html | text/html |
Text | .txt | text/plain |
Markdown | .md | text/markdown |
Notes on indexing
- The file it will initially have a status of
indexing_pending
and will be indexed asynchronously. The time it takes to index the file will depend on the file size and the current load on the system. - You can check the status of the file by calling the Get File endpoint and checking that the
file.status
property has changed toindexing_completed
. - If the indexing failed the status will be set to
indexing_failed
and the reason of the failure will be available in thefailedStatusReason
property of the file.