This guide is designed to help answer some of the most common questions and issues you might run into while using Super's APIs.
Question: I indexed documents for my data source, however, the document is not appearing in search results.
Answer: When using the /indexdocument and /bulkindexdocuments endpoints, documents are added to a queue for processing and are not indexed immediately. This might be why users don’t see these items in search results right away. To speed up document indexing, you can use the /processalldocuments endpoint to schedule the immediate processing of your documents. You can also confirm if a document has been uploaded/indexed or not using the get document information endpoint. If the document has been uploaded and indexed, there might be a permission issue. You can validate if a user has permission to view a document with the check document access endpoint.
Question: How can I delete documents from my custom data source?
Answer: You can delete documents using the /deletedocument endpoint. Alternatively, the /bulkindexdocuments endpoint will remove documents from the data source index that are not present in the upload. To delete all documents, you can use /bulkindexdocuments with an empty documents array and set disableStaleDocumentDeletionCheck to true.
Question: Is there example documentation on how to use and implement different endpoints?
Answer: Yes, we have a public GitHub repository with examples for our APIs. You can find it here.
Question: I created a custom data source, why is the ‘Results Display’ section empty/blank in the UI?
Answer: We don't show the results display options until object definitions are created for the datasource. This is because you can customize the results display based on the object type. For more information on setting up object definitions, please refer to our documentation on custom properties.
We hope this FAQ helps you in using Super's REST APIs effectively. If you have any further questions, please feel free to reach out to our support team.