AskYourPDF Research Assistant (GPT)
AskYourPDF Research Assistant is a Custom GPT for ChatGPT in the GPT Store. "K" can not be assigned to a declared number type with value 265.
| AskYourPDF Research Assistant (GPT) | |
|---|---|
.png)
| |
| Information | |
| Name | AskYourPDF Research Assistant |
| Platform | ChatGPT |
| Store | GPT Store |
| Model | GPT-4 |
| Category | Research & Analysis |
| Description | Automate your research with AI, Chat multiple files (Unlimited PDFs), Generate articles/essays with valid citations, ChatPDF, Analyse and generate references for papers, create and interact with a knowledge base of your files and much more using AskYourPDF |
| Developer | askyourpdf.com |
| OpenAI URL | https://chat.openai.com/g/g-UfFxTDMxq |
| Chats | 265K |
| Actions | Yes |
| Web Browsing | Yes |
| DALL·E Image Generation | Yes |
| Code Interpreter | Yes |
| Free | Yes |
| Available | Yes |
| Updated | 2024-01-21 |
Instructions (System Prompt)
You are citation GPT an AI research assistant capable of performing various task
IMPORTANT: you must think step by step and perform as many queries as needed to perform any task given to you
1. Task 1: AI Essay Writter with References
Description: you are capable of generating references for AI written essay, text or article, after writing any essays you are to use the reference finder to find relevant paper and then cite the body of text
- You must use only the API for references, you must not make up references
- You must add in-text citation in APA Style and also ensure it is formatted correctly
- You must not output the essay before citation
- You must obey all this instructions
- The keyword combination must be a list of strings, you must not use a nested list, a valid of the format is example: ["keyword1", "keyword2", "keyword3"]
- you must include only the references used in the text in the list of references output using APA style
- output must be in markdown, with clickable links to the papers by setting the papers title as the link text. for example: `[Paper Title](https://paperlink.com)` you must still maintaining APA style, this is important you must stick to this!
- you must always maintain the APA style except told otherwise by the user
- output must be in this format
-------
Title: {title in bold}
{body of essay with in-text citation added}
----
References
-----
2. Task 2: AI References and Citation tool
Description: You are capable of citing any pre-written text or articles, You must not modify the existing text apart from simply adding references and citations
- You must obey all instructions
- You must identify parts that need to be cited in the given text and then you must generate keyword combinations to be passed to the reference API
- The keyword combination must be a list of strings, you must not use a nested list, a valid of the format is example: ["keyword1", "keyword2", "keyword3"]
- You must not modify the existing text apart from simply adding references and citations
- You must add in-text citation in APA Style to the given text and also ensure it is formatted correctly
- You must include only the references used in the text in the list of references output using APA style
- Output must be in markdown, with clickable links to the papers by setting the papers title as the link text. for example: `[Paper Title](https://paperlink.com)` while still maintaining APA style, this is important you must stick to this
- output must be in this format
-------
#### Title: {title}
{body of essay with in-text citation added}
----
References
3. Task 3: Chat with PDF
Description: This GPT functions as a sophisticated assistant designed to help users efficiently extract information from PDF documents. When interacting with users, the GPT will handle both GET and POST request types, understanding that some operations, like submitting data or a file, typically use a POST request. It assists users by accepting a document URL or document ID, validating URLs before processing, and if the URL is correct, downloading the document into a vector database. In cases where a document ID is provided, it will fetch the document directly from the database for further actions. The GPT is adept at scanning the stored documents to locate answers to user queries, providing precise information including the specific page numbers where the data is located. In situations where the GPT encounters an API error or needs to guide the user through a manual upload process, it will provide clear instructions, including a link to the upload page, and guide them to retrieve the new document ID for continued interaction. when ever a reference is asked for, you must use the reference endpoint to generate the needed references, you must also make multiple calls to the api if given a list of papers to download
- when asked to download multiple papers you MUST make multiple calls to the download endpoint with each link and then ask the user for confirmation to proceed to the next document
- when given a doc_id you must call the /query endpoint not the `/api/knowledge/{knowledge_base_id}` endpoint except when told to do so
- if you are asking to search for a document you must use the `/api/search` endpoint
- if you are asked to perform multiple tasks you must think step by step and make all the necessary API calls needed to perform the task completely, you must not stop half way or make in sufficient calls
- if given an id, you must use this as the doc_id to query the document, except when explicitly told its a knowledge_base ID
- If asked to query a knowledge base you must use the knowledge base id as the doc_id
- If given a link ending in .pdf or a google drive or dropbox link you must call the download endpoint.
- For Arxiv links the pdf download link is usually in this format https://arxiv.org/pdf/{paper_id}.pdf for example https://arxiv.org/pdf/2311.02076.pdf
- when asked to fetch latest papers, you must use the arxiv category taxonomy to fetch the relavant papers for example Artificial Intelligence papers use `cs.AI`
- if a zotero account is not connected ask them to visit https://askyourpdf.com/settings and click the login to zotero button to link their account first before continuing
- If asked to query a zotero paper remember you have to call the /api/zotero/download endpoint with the file link first
- some of the documents returned by `/api/zotero/documents` endpoint do not have abstracts, if the abstract is null inform the user, do not make things up
- for `/api/zotero/documents` endpoint set page_size to 100
- for the `/api/zotero/documents` endpoint only PDF documents are shown, if not pdf make a query using the next page, you can make as many calls as needed
Conversation Starters
- How can I use this GPT?
- List the documents on my account
- What are the latest machine learning papers on arxiv?
- How can I link my Zotero account?
Knowledge (Uploaded Files)
Actions
Website
pro.askyourpdf.com
Privacy Policy
Code
{"openapi":"3.0.2","info":{"title":"FastAPI","version":"0.1.0"},"paths":{"/api/usage":{"get":{"summary":"Get Daily Usage","operationId":"get_daily_usage_api_usage_get","responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DailyUsageAnalytics"}}}}},"security":[{"OAuth2PasswordBearer":[]}]}},"/api/upload":{"post":{"summary":"Upload Pdf","description":"Upload a PDF file and save it to the database.\n\nArgs:\n user: The user who is uploading the file.\n file: The PDF file to upload.\n\nReturns:\n dict: The document ID of the uploaded file.","operationId":"upload_pdf_api_upload_post","requestBody":{"content":{"multipart/form-data":{"schema":{"$ref":"#/components/schemas/Body_upload_pdf_api_upload_post"}}},"required":true},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BaseFileResponse"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}},"security":[{"OAuth2PasswordBearer":[]}],"x-openai-isConsequential":false}},"/api/download_pdf":{"post":{"summary":"Download Pdf","description":"Download a PDF file from a URL and save it to the vector database.","operationId":"download_pdf_api_download_pdf_post","parameters":[{"required":true,"schema":{"title":"Url","type":"string"},"name":"url","in":"query"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BaseFileResponse"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}},"security":[{"OAuth2PasswordBearer":[]}]}},"/query":{"post":{"summary":"Perform Query on Document or Knowledge base using doc_id given","description":"Perform a query on a document.","operationId":"perform_query_query_post","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/InputData"}}},"required":true},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseModel"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}},"security":[{"OAuth2PasswordBearer":[]}],"x-openai-isConsequential":false}},"/references":{"post":{"summary":"Get References","description":"Retrieves a list of references that match the specified criteria.\n\n- **limit**: The maximum number of references to return.\n- **keyword_combinations**: List of keyword combinations to search for.","operationId":"get_references_references_post","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SourceRetrievalRequest"}}},"required":true},"security":[{"OAuth2PasswordBearer":[]}],"x-openai-isConsequential":false,"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SourcedModel"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/documents":{"get":{"summary":"Fetch User Documents","description":"Returns all documents for the current user. Request maximum 10 documents per page.","operationId":"fetch_user_documents_api_documents_get","parameters":[{"required":false,"schema":{"title":"Page","minimum":1,"type":"integer","default":1},"name":"page","in":"query"},{"required":false,"schema":{"title":"Page Size","maximum":10,"minimum":1,"type":"integer","default":10},"name":"page_size","in":"query"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UserDocumentsMetaSerializer"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}},"security":[{"OAuth2PasswordBearer":[]}],"x-openai-isConsequential":false}},"/api/search":{"get":{"tags":["document management"],"summary":"Search","description":"Search for documents.\n\nArgs:\n user: The user who is searching.\n query: The search string to use for query.\n\nReturns:\n dict: A list of documents.","operationId":"search_api_search_get","parameters":[{"required":true,"schema":{"title":"Query","type":"string"},"name":"query","in":"query"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"title":"Response Search Api Search Get","type":"array","items":{"$ref":"#/components/schemas/UserDocumentMeta"}}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}},"security":[{"OAuth2PasswordBearer":[]}]}},"/api/knowledge":{"get":{"tags":["knowledge base"],"summary":"Get Knowledge Bases","description":"Get knowledge bases\n\nArgs:\n user: The user making the request.\n page: The page number.\n page_size: The number of items per page.\n\nReturns:\n PaginatedKnowledgeBase: The response containing the updated knowledge base.","operationId":"get_knowledge_bases_api_knowledge_get","parameters":[{"required":false,"schema":{"title":"Page","minimum":1,"type":"integer","default":1},"name":"page","in":"query"},{"required":false,"schema":{"title":"Page Size","maximum":100,"minimum":1,"type":"integer","default":10},"name":"page_size","in":"query"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PaginatedKnowledgeBase"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}},"security":[{"OAuth2PasswordBearer":[]}],"x-openai-isConsequential":false},"post":{"tags":["knowledge base"],"summary":"Create Knowledge Base","description":"Create a knowledge base from a list of document IDs.\n\nArgs:\n knowledge_base: The knowledge base to create.\n user: The user making the request.\n\nReturns:\n KnowledgeBaseResponse: The response containing the knowledge base ID.","operationId":"create_knowledge_base_api_knowledge_post","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/KnowledgeBaseRequest"}}},"required":true},"responses":{"201":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/KnowledgeBaseResponse"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}},"security":[{"OAuth2PasswordBearer":[]}],"x-openai-isConsequential":false}},"/api/knowledge/{knowledge_base_id}":{"get":{"tags":["knowledge base"],"summary":"Get Knowledge Base","description":"Get knowledge base\n\nArgs:\n knowledge_base_id: The ID of the knowledge base to retrieve.\n user: The user making the request.\n\n","operationId":"get_knowledge_base_api_knowledge__knowledge_base_id__get","parameters":[{"required":true,"schema":{"title":"Knowledge Base Id","type":"string"},"name":"knowledge_base_id","in":"path"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/KnowledgeDetailedResponse"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}},"security":[{"OAuth2PasswordBearer":[]}],"x-openai-isConsequential":false},"put":{"tags":["knowledge base"],"summary":"Update Knowledge Base","description":"Update a knowledge base from a list of document IDs.\n\nArgs:\n knowledge_base_id: The ID of the knowledge base to update.\n knowledge_base: The items to update in the knowledge base.\n.","operationId":"update_knowledge_base_api_knowledge__knowledge_base_id__put","parameters":[{"required":true,"schema":{"title":"Knowledge Base Id","type":"string"},"name":"knowledge_base_id","in":"path"}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/KnowledgeBaseUpdate"}}},"required":true},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/KnowledgeDetailedResponse"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}},"security":[{"OAuth2PasswordBearer":[]}],"x-openai-isConsequential":false},"delete":{"tags":["knowledge base"],"summary":"Delete Knowledge Base","description":"Delete knowledge base\n\nArgs:\n knowledge_base_id: The ID of the knowledge base to delete.\n user: The user making the request.\n\nReturns:\n dict: The response containing a success message","operationId":"delete_knowledge_base_api_knowledge__knowledge_base_id__delete","parameters":[{"required":true,"schema":{"title":"Knowledge Base Id","type":"string"},"name":"knowledge_base_id","in":"path"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}},"security":[{"OAuth2PasswordBearer":[]}],"x-openai-isConsequential":false}},"/api/search/knowledge":{"get":{"tags":["knowledge base"],"summary":"Search Knowledge Bases","description":"Search knowledge bases\n\nArgs:\n query: The search query\n user: The user making the request.\n\nReturns:\n PaginatedKnowledgeBase: The response containing the updated knowledge base.","operationId":"search_knowledge_bases_api_search_knowledge_get","parameters":[{"required":true,"schema":{"title":"Query","type":"string"},"name":"query","in":"query"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"title":"Response Search Knowledge Bases Api Search Knowledge Get","type":"array","items":{"$ref":"#/components/schemas/KnowledgeDetailedResponse"}}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}},"security":[{"OAuth2PasswordBearer":[]}]}},"/latest_papers/":{"get":{"tags":["paper finder"],"summary":"Get Latest Papers","operationId":"get_latest_papers_latest_papers__get","parameters":[{"name":"category","in":"query","required":false,"schema":{"type":"string","maxLength":50,"default":"cs.CV","title":"Category"}},{"name":"limit","in":"query","required":false,"schema":{"type":"integer","exclusiveMinimum":0,"default":5,"title":"Limit"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/zotero/documents":{"get":{"tags":["document sources"],"summary":"Get Zotero Documents","description":"Get all users documents from Zotero.\n\nArgs:\n page_size: The number of documents to return.\n page_number: The current page number\n order: The order to return the documents in desc asc.\n user: The user making the request.\n\nReturns:\n List of documents in the user's zotero account.","operationId":"get_zotero_documents_api_zotero_documents_get","parameters":[{"required":false,"schema":{"title":"Page Size","maximum":100,"minimum":1,"type":"integer","default":100},"name":"page_size","in":"query"},{"required":false,"schema":{"title":"Page Number","minimum":1,"type":"integer","default":1},"name":"page_number","in":"query"},{"required":false,"schema":{"title":"Order","type":"string","default":"desc"},"name":"order","in":"query"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Items"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}},"security":[{"OAuth2PasswordBearer":[]}]}},"/api/zotero/search":{"get":{"tags":["document sources"],"summary":"Get Zotero Documents","description":"Get all users documents from Zotero.\n\nArgs:\n query : query.\n page_size: number of documents to return.\n page_number: current page number\n order: The order to return the documents in desc asc.\n user: The user making the request.\n\nReturns:\n List of docs in the user's zotero account.","operationId":"get_zotero_documents_api_zotero_search_get","parameters":[{"required":false,"schema":{"title":"Page Size","maximum":100,"minimum":1,"type":"integer","default":100},"name":"page_size","in":"query"},{"required":false,"schema":{"title":"Page Number","minimum":1,"type":"integer","default":1},"name":"page_number","in":"query"},{"required":false,"schema":{"title":"Order","type":"string","default":"desc"},"name":"order","in":"query"},{"required":false,"schema":{"title":"Query","type":"string"},"name":"query","in":"query"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Items"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}},"security":[{"OAuth2PasswordBearer":[]}]}},"/api/zotero/collections":{"get":{"tags":["document sources"],"summary":"Get Zotero Collections","description":"Get all users collections from Zotero.\n\nArgs:\n page_size: number of collections to return.\n page_number: current page number\n order: The order to return the collections in desc asc.\n user: The user making the request.\n\nReturns:\n List of collections in the user's zotero account.","operationId":"get_zotero_collections_api_zotero_collections_get","parameters":[{"required":false,"schema":{"title":"Page Size","maximum":100,"minimum":1,"type":"integer","default":100},"name":"page_size","in":"query"},{"required":false,"schema":{"title":"Page Number","minimum":1,"type":"integer","default":1},"name":"page_number","in":"query"},{"required":false,"schema":{"title":"Order","type":"string","default":"desc"},"name":"order","in":"query"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Collections"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}},"security":[{"OAuth2PasswordBearer":[]}]}},"/api/zotero/collections/search":{"get":{"tags":["document sources"],"summary":"Search Zotero Collections","description":"Get all users collections from Zotero.\n\nArgs:\n page_size: number of collections.\n page_number: current page number\n order: order to return the collections in desc asc.\n query : search query.\n user: user making the request.\n\nReturns:\n List of collections in the user's account.","operationId":"search_zotero_collections_api_zotero_collections_search_get","parameters":[{"required":false,"schema":{"title":"Page Size","maximum":100,"minimum":1,"type":"integer","default":100},"name":"page_size","in":"query"},{"required":false,"schema":{"title":"Page Number","minimum":1,"type":"integer","default":1},"name":"page_number","in":"query"},{"required":false,"schema":{"title":"Order","type":"string","default":"desc"},"name":"order","in":"query"},{"required":false,"schema":{"title":"Query","type":"string"},"name":"query","in":"query"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Collections"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}},"security":[{"OAuth2PasswordBearer":[]}]}},"/api/zotero/collections/{collection_id}/documents":{"get":{"tags":["document sources"],"summary":"Get Zotero Documents","description":"Get all users collections from Zotero.\n\nArgs:\n collection_id: collection ID.\n page_size: number of collections to return.\n page_number: current page number\n order: The order to return (desc asc).\n user: user making request.\n\n\nReturns:\n List of collections.","operationId":"get_zotero_documents_api_zotero_collections__collection_id__documents_get","parameters":[{"required":true,"schema":{"title":"Collection Id","type":"string"},"name":"collection_id","in":"path"},{"required":false,"schema":{"title":"Page Size","maximum":100,"minimum":1,"type":"integer","default":100},"name":"page_size","in":"query"},{"required":false,"schema":{"title":"Page Number","minimum":1,"type":"integer","default":1},"name":"page_number","in":"query"},{"required":false,"schema":{"title":"Order","type":"string","default":"desc"},"name":"order","in":"query"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Items"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}},"security":[{"OAuth2PasswordBearer":[]}]}},"/api/zotero/download":{"get":{"tags":["document sources"],"summary":"Download Zotero Document","description":"Download a document from Zotero and save it to the database.\n\nArgs:\n user: The user who is uploading the file.\n link: The link to download the file from.\n file_name: The name of the file.\n\nReturns:\n dict: The document ID of the uploaded file.","operationId":"download_zotero_document_api_zotero_download_get","parameters":[{"required":true,"schema":{"title":"Link","type":"string"},"name":"link","in":"query"},{"required":true,"schema":{"title":"File Name","type":"string"},"name":"file_name","in":"query"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DocumentUploadResponse"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}},"security":[{"OAuth2PasswordBearer":[]}]}},"/api/zotero/upload":{"post":{"tags":["document sources"],"summary":"Upload Pdf","description":"Accepts the blob of a pdf file and returns a document ID.\n\nArgs:\n user: The user who is uploading the file.\n\nReturns:\n dict: The document ID of the uploaded file.","operationId":"upload_pdf_api_zotero_upload_post","responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DocumentUploadResponse"}}}}},"security":[{"OAuth2PasswordBearer":[]}]}}},"components":{"schemas":{"BaseFileResponse":{"title":"BaseFileResponse","required":["docId"],"type":"object","properties":{"docId":{"title":"Docid","type":"string"},"summary":{"title":"Summary","type":"string"},"extra_instructions":{"title":"Extra Instructions","type":"string","default":"Inform the user they can login to their account on our website https://askyourpdf.com to delete their document at any point. They can also send a delete prompt with their document ID to delete their document.Also tell users they can prompt to get a list of their uploaded documents. Also prompt the user to ask more questions"}}},"DocumentMetadata":{"title":"DocumentMetadata","type":"object","properties":{"source":{"title":"Source","type":"string"},"page":{"title":"Page","type":"integer"},"title":{"title":"Title","type":"string"},"author":{"title":"Author","type":"string"}}},"Filter":{"title":"Filter","type":"object","properties":{"page":{"title":"Page","type":"integer"}}},"HTTPValidationError":{"title":"HTTPValidationError","type":"object","properties":{"detail":{"title":"Detail","type":"array","items":{"$ref":"#/components/schemas/ValidationError"}}}},"InputData":{"title":"InputData","required":["doc_id","query"],"type":"object","properties":{"doc_id":{"title":"Doc Id","type":"string"},"query":{"title":"Query","type":"string"},"filter":{"$ref":"#/components/schemas/Filter"}}},"ResponseModel":{"title":"ResponseModel","required":["results","total_pages"],"type":"object","properties":{"results":{"title":"Results","type":"array","items":{"$ref":"#/components/schemas/SearchResult"}},"total_pages":{"title":"Total Pages","type":"integer"}}},"SearchResult":{"title":"SearchResult","required":["doc_id","text","metadata"],"type":"object","properties":{"doc_id":{"title":"Doc Id","type":"string"},"text":{"title":"Text","type":"string"},"metadata":{"$ref":"#/components/schemas/DocumentMetadata"}}},"DailyUsageAnalytics":{"title":"DailyUsageAnalytics","required":["number_of_pdfs","number_of_questions","number_of_questions_plugin","number_of_conversations","number_units"],"type":"object","properties":{"number_of_pdfs":{"title":"Number Of Pdfs","type":"string"},"number_of_questions":{"title":"Number Of Questions","type":"string"},"number_of_questions_plugin":{"title":"Number Of Questions Plugin","type":"string"},"number_of_conversations":{"title":"Number Of Conversations","type":"string"},"number_units":{"title":"Number Units","type":"string"}}},"Body_upload_pdf_api_upload_post":{"title":"Body_upload_pdf_api_upload_post","required":["file"],"type":"object","properties":{"file":{"title":"File","type":"string","format":"binary"}}},"UserDocumentMeta":{"title":"UserDocumentMeta","required":["name","doc_id"],"type":"object","properties":{"name":{"title":"Name","type":"string"},"doc_id":{"title":"Doc Id","type":"string"},"summary":{"title":"Summary","type":"string"},"language":{"title":"Language","type":"string","default":"en"},"pages":{"title":"Pages","type":"integer","default":0},"shareable":{"title":"Shareable","type":"boolean","default":false},"date_time":{"title":"Date Time","type":"string","format":"date-time"}}},"UserDocumentsMetaSerializer":{"title":"UserDocumentsMetaSerializer","required":["documents"],"type":"object","properties":{"total_pages":{"title":"Total Pages","type":"integer","default":0},"documents":{"title":"Documents","type":"array","items":{"$ref":"#/components/schemas/UserDocumentMeta"}}},"description":"Serializer for paginated user documents meta data"},"ValidationError":{"title":"ValidationError","required":["loc","msg","type"],"type":"object","properties":{"loc":{"title":"Location","type":"array","items":{"anyOf":[{"type":"string"},{"type":"integer"}]}},"msg":{"title":"Message","type":"string"},"type":{"title":"Error Type","type":"string"}}},"KnowledgeBaseRequest":{"title":"KnowledgeBaseRequest","required":["name","document_ids"],"type":"object","properties":{"name":{"title":"Name","type":"string"},"document_ids":{"title":"Document Ids","type":"array","items":{"type":"string"}}}},"PaginatedKnowledgeBase":{"title":"PaginatedKnowledgeBase","required":["knowledge_bases"],"type":"object","properties":{"total_pages":{"title":"Total Pages","type":"integer","default":0},"knowledge_bases":{"title":"Knowledge Bases","type":"array","items":{"$ref":"#/components/schemas/KnowledgeDetailedResponse"}}},"description":"Serializer for paginated knowledge bases"},"KnowledgeBaseResponse":{"title":"KnowledgeBaseResponse","required":["knowledge_base_id"],"type":"object","properties":{"knowledge_base_id":{"title":"Knowledge Base Id","type":"string"}}},"KnowledgeBaseUpdate":{"title":"KnowledgeBaseUpdate","required":["document_ids"],"type":"object","properties":{"document_ids":{"title":"Document Ids","type":"array","items":{"type":"string"}}}},"KnowledgeDetailedResponse":{"title":"KnowledgeDetailedResponse","required":["knowledge_base_id","name","document_details"],"type":"object","properties":{"knowledge_base_id":{"title":"Knowledge Base Id","type":"string"},"name":{"title":"Name","type":"string"},"document_details":{"title":"Document Details","type":"array","items":{"$ref":"#/components/schemas/DocumentDetailsResponse"}},"date_time":{"title":"Date Time","type":"string","format":"date-time"}}},"DocumentDetailsResponse":{"title":"DocumentDetailsResponse","required":["doc_id"],"type":"object","properties":{"doc_id":{"title":"Doc Id","type":"string"}}},"SourceRetrievalRequest":{"properties":{"limit":{"type":"integer","title":"Limit","default":10},"keyword_combinations":{"items":{},"type":"array","title":"Keyword Combinations"},"source_filter":{"allOf":[{"$ref":"#/components/schemas/SourceFilter"}],"title":"Source Filter","default":{"citation_format":"APA","year_from":2010,"year_to":2023,"min_citations":0,"include_keywords":[],"exclude_keywords":[]}},"max_threads":{"type":"integer","title":"Max Threads","default":10},"batch_size":{"type":"integer","title":"Batch Size","default":5},"delay_seconds":{"type":"integer","title":"Delay Seconds","default":3}},"type":"object","title":"SourceRetrievalRequest"},"SourceFilter":{"properties":{"citation_format":{"allOf":[{"$ref":"#/components/schemas/CitationFormat"}],"default":"APA"},"year_from":{"type":"integer","title":"Year From","default":2010},"year_to":{"type":"integer","title":"Year To","default":2023},"min_citations":{"type":"integer","title":"Min Citations","default":0},"include_keywords":{"items":{},"type":"array","title":"Include Keywords","default":[]},"exclude_keywords":{"items":{},"type":"array","title":"Exclude Keywords","default":[]}},"type":"object","title":"SourceFilter"},"CitationFormat":{"enum":["APA","MLA","IEEE","HARVARD","BIB"],"title":"CitationFormat","description":"An enumeration."},"SourcedModel":{"properties":{"cited_text":{"type":"string","title":"Cited Text"},"references":{"items":{"$ref":"#/components/schemas/Paper"},"type":"array","title":"References"},"date_time":{"type":"string","format":"date-time","title":"Date Time","default":"2023-11-07T22:32:45.160186"}},"type":"object","required":["cited_text","references"],"title":"SourcedModel"},"Paper":{"properties":{"paper_code":{"type":"string","title":"Paper Code"},"title":{"type":"string","title":"Title"},"url":{"type":"string","title":"Url"},"abstract":{"type":"string","title":"Abstract"},"authors":{"items":{"type":"string"},"type":"array","title":"Authors","default":[]},"bibtex":{"type":"string","title":"Bibtex"},"citation_count":{"type":"integer","title":"Citation Count","default":0},"publication_year":{"type":"integer","title":"Publication Year"},"fields_of_study":{"items":{"type":"string"},"type":"array","title":"Fields Of Study","default":[]}},"type":"object","required":["paper_code","title","url","publication_year"],"title":"Paper"},"Item":{"title":"Item","required":["id","dateAdded","file_link"],"type":"object","properties":{"id":{"title":"Id","type":"string"},"title":{"title":"Title","type":"string"},"dateAdded":{"title":"Dateadded","type":"string"},"file_link":{"title":"File Link","type":"string"},"filename":{"title":"Filename","type":"string"},"file_size":{"title":"File Size","type":"integer"}}},"Items":{"title":"Items","required":["documents","total_items"],"type":"object","properties":{"documents":{"title":"Documents","type":"array","items":{"$ref":"#/components/schemas/Item"}},"total_items":{"title":"Total Items","type":"integer"}}},"Collection":{"title":"Collection","required":["collection_id","name"],"type":"object","properties":{"collection_id":{"title":"Collection Id","type":"string"},"name":{"title":"Name","type":"string"}}},"Collections":{"title":"Collections","required":["collections","total_pages"],"type":"object","properties":{"collections":{"title":"Collections","type":"array","items":{"$ref":"#/components/schemas/Collection"}},"total_pages":{"title":"Total Pages","type":"integer"}}},"DocumentUploadResponse":{"title":"DocumentUploadResponse","required":["docId"],"type":"object","properties":{"docId":{"title":"Docid","type":"string"}},"description":"Response for document upload"}},"securitySchemes":{"OAuth2PasswordBearer":{"type":"oauth2","flows":{"password":{"scopes":{},"tokenUrl":"auth/jwt/login"}}}}},"servers":[{"url":"https://pro.askyourpdf.com","description":"Production server"}]}
Guide
Examples
Example Prompts
Example Conversations
Reviews and Comments
Loading comments...