Skip to content

Query

Source code in docs_src/capo_textract/types/query.py 
14
15
16
17
18
19
20
class Query(TypedDict, closed=True):
    text: "capo_textract.types.query_input.QueryInput"
    """<p>Question that Amazon Textract will apply to the document. An example would be "What is the customer's SSN?"</p>"""
    alias: NotRequired["capo_textract.types.query_input.QueryInput"]
    """<p>Alias attached to the query, for ease of location.</p>"""
    pages: NotRequired["capo_textract.types.query_pages.QueryPages"]
    """<p>Pages is a parameter that the user inputs to specify which pages to apply a query to. The following is a list of rules for using this parameter.</p> <ul> <li> <p>If a page is not specified, it is set to <code>["1"]</code> by default.</p> </li> <li> <p>The following characters are allowed in the parameter's string: <code>0 1 2 3 4 5 6 7 8 9 - *</code>. No whitespace is allowed.</p> </li> <li> <p>When using * to indicate all pages, it must be the only element in the list.</p> </li> <li> <p>You can use page intervals, such as <code>[“1-3”, “1-1”, “4-*”]</code>. Where <code>*</code> indicates last page of document.</p> </li> <li> <p>Specified pages must be greater than 0 and less than or equal to the number of pages in the document.</p> </li> </ul>"""

alias instance-attribute 

alias: NotRequired[QueryInput]

Alias attached to the query, for ease of location.

pages instance-attribute 

pages: NotRequired[QueryPages]

Pages is a parameter that the user inputs to specify which pages to apply a query to. The following is a list of rules for using this parameter.

  • If a page is not specified, it is set to ["1"] by default.

  • The following characters are allowed in the parameter's string: 0 1 2 3 4 5 6 7 8 9 - *. No whitespace is allowed.

  • When using * to indicate all pages, it must be the only element in the list.

  • You can use page intervals, such as [“1-3”, “1-1”, “4-*”]. Where * indicates last page of document.

  • Specified pages must be greater than 0 and less than or equal to the number of pages in the document.

text instance-attribute 

text: QueryInput

Question that Amazon Textract will apply to the document. An example would be "What is the customer's SSN?"