AskYourPDF

Description

Unlock the power of your PDFs!, dive into your documents, find answers, and bring information to your fingertips

Details

Added7 months ago

Votes0

Total Installations0

Categorytext to text

Websiteaskyourpdf.com

https://plugin.askyourpdf.com/.well-known/ai-plugin.json

{
    "schema_version": "v1",
    "name_for_model": "askyourpdf",
    "name_for_human": "AskYourPDF",
    "description_for_model": "This plugin is designed to expedite the extraction of information from PDF documents. It works by accepting a URL link to a PDF or a document ID (doc_id) from the user. If a URL is provided, the plugin first validates that it is a correct URL. \\nAfter validating the URL, the plugin proceeds to download the PDF and store its content in a vector database. If the user provides a doc_id, the plugin directly retrieves the document from the database. The plugin then scans through the stored PDFs to find answers to user queries or retrieve specific details.\\n\\nHowever, if an error occurs while querying the API, the user is prompted to download their document first, then manually upload it to [![Upload Document](https://raw.githubusercontent.com/AskYourPdf/ask-plugin/main/upload.png)](https://askyourpdf.com/upload). Once the upload is complete, the user should copy the resulting doc_id and paste it back into the chat for further interaction.\nThe plugin is particularly useful when the user's question pertains to content within a PDF document. When providing answers, the plugin also specifies the page number (highlighted in bold) where the relevant information was found. Remember, the URL must be valid for a successful query. Failure to validate the URL may lead to errors or unsuccessful queries.",
    "description_for_human": "Unlock the power of your PDFs!, dive into your documents, find answers, and bring information to your fingertips.",
    "auth": {
        "type": "none"
    },
    "api": {
        "type": "openapi",
        "url": "https://plugin.askyourpdf.com/.well-known/openapi.yaml",
        "has_user_authentication": false
    },
    "logo_url": "https://plugin.askyourpdf.com/.well-known/logo.png",
    "contact_email": "plugin@askyourpdf.com",
    "legal_info_url": "https://askyourpdf.com/terms"
}

https://plugin.askyourpdf.com/.well-known/openapi.yaml

openapi: 3.0.2
info:
  title: FastAPI
  version: 0.1.0
paths:
  /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/FileResponse'
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
  /query:
    post:
      summary: Perform Query
      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'
components:
  schemas:
    DocumentMetadata:
      title: DocumentMetadata
      required:
        - source
        - page_number
        - author
      type: object
      properties:
        source:
          title: Source
          type: string
        page_number:
          title: Page Number
          type: integer
        author:
          title: Author
          type: string
    FileResponse:
      title: FileResponse
      required:
        - docId
      type: object
      properties:
        docId:
          title: Docid
          type: string
        error:
          title: Error
          type: string
    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
    ResponseModel:
      title: ResponseModel
      required:
        - results
      type: object
      properties:
        results:
          title: Results
          type: array
          items:
            $ref: '#/components/schemas/SearchResult'
    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'
    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

Discover other plugins from the text to text category

1 Votes

ChatWithPDF

Plugin for asking questions, analyzing, and parsing through PDF documents by simply providing a PDF URL.

0 Comments

0 Votes

Auto Anno

This plugin utilizes the power of large AI models to perform automatic annotation on input texts.

0 Comments

0 Votes

DocsBot

Plugin for searching documents (such as files, websites, and more) from various subject libraries the user has indexed on DocsBot

0 Comments

2 Votes

JiggyBase

JiggyBase is a tool for searching through collections of user’s documents on JiggyBase using semantic search to provide relevant content to better answer user questions based on the facts and up-to-date information contained in those documents.

0 Comments