Ask Koncierge To Extract Information From A Document

📘

Prerequisites

Ensure you have learned the Document Processing Book before using this operation. After learning the Book, make sure to publish your Agent and create a new Playground for it to take effect.

Use ask koncierge for to extract information from a document.

Syntax

ask koncierge for {information} where
    the document
    the creativity is {creativity}
    the openai model is "{model}"
    the system command is "{command}"
    the response format is "{format}"
    the message is "{message}"
    the task is "{task}"
    the question is "{question}"
    the rules are "{rules}"
    the visual reference is {visual reference}

Inputs

Required

1. information
   • The specific piece of information or value you are requesting from the system.
   • Examples: the invoice date,the total amount, the delivery status

Optional

1. the document
   • The document from which information needs to be extracted. This will raise a question asking you to Please Provide File.
2. creativity
   • A number that controls the creativity of the response. Higher values produce more creative responses.
   • Default: 0.0
   • Range: 0.0-2.0.
3. model
   • The OpenAI model to use to generate the response.
   • Default: gpt-4-turbo-2024-04-09
4. command
   • A system-level command or instruction that can influence the response.
   • Example: password reset instructions
5. format
   • The desired format of the response.
   • Default: string
   • Allowed Values:
     • string
     • text
     • date
     • table
     • list of texts
     • list of numbers
     • list of dates
     • list of records
     • structured data
     • json
6. message
   • The message you want to send.
7. task
   • The specific task to be performed.
8. question
   • The question you would like answered.
9. rules
   • The user rules to be followed for the task.
10. visual reference
    • A variable to represent a document or image that serves as a visual reference, helping GPT enhance its accuracy. This refers to data defined earlier in the automation.
    • Examples: the file, the document, the text

Example 1

ask koncierge for the invoice date where
  the document
  the task is "extract the invoice date"
  the response format is "date"

Example 2

ask koncierge for the total amount where
  the document
  the system command is "you are an expert invoice processor\ndo not calculate the total amount manually"
  the task is "Extract the total amount"
  the response format is "number"