Introduction + Concepts

The Pyq Document Q&A API allows you to answer questions about your own documents using AI.

This can be used to answer questions about your product documentation, to help parse through call transcripts, answer questions about large PDFs that are difficult to parse, and more.

​

Documents

Documents are txt, md, or pdf files that contain information you want to use to answer various queries. They can be uploaded, and updated

​

Indexes

Documents are grouped by index. You can create an index here - this will upload your first document, and create an index containing that document. You can then answer queries in that index, which will be answered by AI consulting your uploaded documents.

Additional documents can be uploaded, and existing documents can be updated

​

Queries

Once you have uploaded some documents, you can begin to query them using the ask API. This will then use AI to answer your query using the information in the documents uploaded to that index. Note that it will only use documents in this index, and not documents uploaded to other indices.

​

Tips

Organizing your indices can make a significant difference in the performance of our AI. For example, if you are answering a query about a specific user, and you have documents for many users, it makes sense to have one index per user, and to run queries on a per-user basis. If you are struggling to get good query answers out of our API, feel free to Contact us or book a call here and we’ll happily suggest some indexing stategies.