Class: Aws::Textract::Types::Query
- Inherits:
-
Struct
- Object
- Struct
- Aws::Textract::Types::Query
- Includes:
- Structure
- Defined in:
- lib/aws-sdk-textract/types.rb
Overview
When making an API call, you may pass Query data as a hash:
{
text: "QueryInput", # required
alias: "QueryInput",
pages: ["QueryPage"],
}
Each query contains the question you want to ask in the Text and the alias you want to associate.
Constant Summary collapse
- SENSITIVE =
[]
Instance Attribute Summary collapse
-
#alias ⇒ String
Alias attached to the query, for ease of location.
-
#pages ⇒ Array<String>
List of pages associated with the query.
-
#text ⇒ String
Question that Amazon Textract will apply to the document.
Instance Attribute Details
#alias ⇒ String
Alias attached to the query, for ease of location.
1523 1524 1525 1526 1527 1528 1529 |
# File 'lib/aws-sdk-textract/types.rb', line 1523 class Query < Struct.new( :text, :alias, :pages) SENSITIVE = [] include Aws::Structure end |
#pages ⇒ Array<String>
List of pages associated with the query. 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 string.
-
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.
1523 1524 1525 1526 1527 1528 1529 |
# File 'lib/aws-sdk-textract/types.rb', line 1523 class Query < Struct.new( :text, :alias, :pages) SENSITIVE = [] include Aws::Structure end |