/*******************************************************************************
* Copyright 2012-2019 Amazon.com, Inc. or its affiliates. All Rights Reserved.
* Licensed under the Apache License, Version 2.0 (the "License"). You may not use
* this file except in compliance with the License. A copy of the License is located at
*
* http://aws.amazon.com/apache2.0
*
* or in the "license" file accompanying this file.
* This file is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR
* CONDITIONS OF ANY KIND, either express or implied. See the License for the
* specific language governing permissions and limitations under the License.
* *****************************************************************************
*
* AWS Tools for Windows (TM) PowerShell (TM)
*
*/
using System;
using System.Collections.Generic;
using System.Linq;
using System.Management.Automation;
using System.Text;
using Amazon.PowerShell.Common;
using Amazon.Runtime;
using Amazon.Textract;
using Amazon.Textract.Model;
namespace Amazon.PowerShell.Cmdlets.TXT
{
///
/// Analyzes an input document for relationships between detected items.
///
///
///
/// The types of information returned are as follows:
/// -
/// Form data (key-value pairs). The related information is returned in two Block
/// objects, each of type
KEY_VALUE_SET
: a KEY Block
object
/// and a VALUE Block
object. For example, Name: Ana Silva Carolina
/// contains a key and value. Name: is the key. Ana Silva Carolina is the
/// value.
/// -
/// Table and table cell data. A TABLE
Block
object contains information
/// about a detected table. A CELL Block
object is returned for each cell
/// in a table.
/// -
/// Lines and words of text. A LINE
Block
object contains one or more WORD
/// Block
objects. All lines and words that are detected in the document
/// are returned (including text that doesn't have a relationship with the value of FeatureTypes
).
///
/// -
/// Signatures. A SIGNATURE
Block
object contains the location information
/// of a signature in a document. If used in conjunction with forms or tables, a signature
/// can be given a Key-Value pairing or be detected in the cell of a table.
/// -
/// Query. A QUERY Block object contains the query text, alias and link to the associated
/// Query results block object.
///
-
/// Query Result. A QUERY_RESULT Block object contains the answer to the query and an
/// ID that connects it to the query asked. This Block also contains a confidence score.
///
/// Selection elements such as check boxes and option buttons (radio buttons) can be detected
/// in form data and in tables. A SELECTION_ELEMENT Block
object contains
/// information about a selection element, including the selection status.
///
/// You can choose which type of analysis to perform by specifying the FeatureTypes
/// list.
///
/// The output is returned in a list of Block
objects.
/// AnalyzeDocument
is a synchronous operation. To analyze documents asynchronously,
/// use StartDocumentAnalysis.
///
/// For more information, see Document
/// Text Analysis.
///
///
[Cmdlet("Invoke", "TXTDocumentAnalysis", SupportsShouldProcess = true, ConfirmImpact = ConfirmImpact.Medium)]
[OutputType("Amazon.Textract.Model.Block")]
[AWSCmdlet("Calls the Amazon Textract AnalyzeDocument API operation.", Operation = new[] {"AnalyzeDocument"}, SelectReturnType = typeof(Amazon.Textract.Model.AnalyzeDocumentResponse))]
[AWSCmdletOutput("Amazon.Textract.Model.Block or Amazon.Textract.Model.AnalyzeDocumentResponse",
"This cmdlet returns a collection of Amazon.Textract.Model.Block objects.",
"The service call response (type Amazon.Textract.Model.AnalyzeDocumentResponse) can also be referenced from properties attached to the cmdlet entry in the $AWSHistory stack."
)]
public partial class InvokeTXTDocumentAnalysisCmdlet : AmazonTextractClientCmdlet, IExecutor
{
#region Parameter S3Object_Bucket
///
///
/// The name of the S3 bucket. Note that the # character is not valid in the file name.
///
///
[System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true)]
[Alias("Document_S3Object_Bucket")]
public System.String S3Object_Bucket { get; set; }
#endregion
#region Parameter Document_Byte
///
///
/// A blob of base64-encoded document bytes. The maximum size of a document that's provided
/// in a blob of bytes is 5 MB. The document bytes must be in PNG or JPEG format.If you're using an AWS SDK to call Amazon Textract, you might not need to base64-encode
/// image bytes passed using the Bytes
field.
///
/// The cmdlet will automatically convert the supplied parameter of type string, string[], System.IO.FileInfo or System.IO.Stream to byte[] before supplying it to the service.
///
[System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true)]
[Alias("Document_Bytes")]
[Amazon.PowerShell.Common.MemoryStreamParameterConverter]
public byte[] Document_Byte { get; set; }
#endregion
#region Parameter DataAttributes_ContentClassifier
///
///
/// Sets whether the input image is free of personally identifiable information or adult
/// content.
///
///
[System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true)]
[Alias("HumanLoopConfig_DataAttributes_ContentClassifiers")]
public System.String[] DataAttributes_ContentClassifier { get; set; }
#endregion
#region Parameter FeatureType
///
///
/// A list of the types of analysis to perform. Add TABLES to the list to return information
/// about the tables that are detected in the input document. Add FORMS to return detected
/// form data. Add SIGNATURES to return the locations of detected signatures. To perform
/// both forms and table analysis, add TABLES and FORMS to FeatureTypes
.
/// To detect signatures within form data and table data, add SIGNATURES to either TABLES
/// or FORMS. All lines and words detected in the document are included in the response
/// (including text that isn't related to the value of FeatureTypes
).
///
///
#if !MODULAR
[System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true)]
#else
[System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true, Mandatory = true)]
[System.Management.Automation.AllowEmptyCollection]
[System.Management.Automation.AllowNull]
#endif
[Amazon.PowerShell.Common.AWSRequiredParameter]
[Alias("FeatureTypes")]
public System.String[] FeatureType { get; set; }
#endregion
#region Parameter HumanLoopConfig_FlowDefinitionArn
///
///
/// The Amazon Resource Name (ARN) of the flow definition.
///
///
[System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true)]
public System.String HumanLoopConfig_FlowDefinitionArn { get; set; }
#endregion
#region Parameter HumanLoopConfig_HumanLoopName
///
///
/// The name of the human workflow used for this image. This should be kept unique within
/// a region.
///
///
[System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true)]
public System.String HumanLoopConfig_HumanLoopName { get; set; }
#endregion
#region Parameter S3Object_Name
///
///
/// The file name of the input document. Synchronous operations can use image files that
/// are in JPEG or PNG format. Asynchronous operations also support PDF and TIFF format
/// files.
///
///
[System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true)]
[Alias("Document_S3Object_Name")]
public System.String S3Object_Name { get; set; }
#endregion
#region Parameter QueriesConfig_Query
///
///
/// The service has not provided documentation for this parameter; please refer to the service's API reference documentation for the latest available information.
///
///
[System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true)]
[Alias("QueriesConfig_Queries")]
public Amazon.Textract.Model.Query[] QueriesConfig_Query { get; set; }
#endregion
#region Parameter S3Object_Version
///
///
/// If the bucket has versioning enabled, you can specify the object version.
///
///
[System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true)]
[Alias("Document_S3Object_Version")]
public System.String S3Object_Version { get; set; }
#endregion
#region Parameter Select
///
/// Use the -Select parameter to control the cmdlet output. The default value is 'Blocks'.
/// Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.Textract.Model.AnalyzeDocumentResponse).
/// Specifying the name of a property of type Amazon.Textract.Model.AnalyzeDocumentResponse will result in that property being returned.
/// Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value.
///
[System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true)]
public string Select { get; set; } = "Blocks";
#endregion
#region Parameter Force
///
/// This parameter overrides confirmation prompts to force
/// the cmdlet to continue its operation. This parameter should always
/// be used with caution.
///
[System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true)]
public SwitchParameter Force { get; set; }
#endregion
protected override void ProcessRecord()
{
this._AWSSignerType = "v4";
base.ProcessRecord();
var resourceIdentifiersText = string.Empty;
if (!ConfirmShouldProceed(this.Force.IsPresent, resourceIdentifiersText, "Invoke-TXTDocumentAnalysis (AnalyzeDocument)"))
{
return;
}
var context = new CmdletContext();
// allow for manipulation of parameters prior to loading into context
PreExecutionContextLoad(context);
if (ParameterWasBound(nameof(this.Select)))
{
context.Select = CreateSelectDelegate(Select) ??
throw new System.ArgumentException("Invalid value for -Select parameter.", nameof(this.Select));
}
context.Document_Byte = this.Document_Byte;
context.S3Object_Bucket = this.S3Object_Bucket;
context.S3Object_Name = this.S3Object_Name;
context.S3Object_Version = this.S3Object_Version;
if (this.FeatureType != null)
{
context.FeatureType = new List(this.FeatureType);
}
#if MODULAR
if (this.FeatureType == null && ParameterWasBound(nameof(this.FeatureType)))
{
WriteWarning("You are passing $null as a value for parameter FeatureType which is marked as required. In case you believe this parameter was incorrectly marked as required, report this by opening an issue at https://github.com/aws/aws-tools-for-powershell/issues.");
}
#endif
if (this.DataAttributes_ContentClassifier != null)
{
context.DataAttributes_ContentClassifier = new List(this.DataAttributes_ContentClassifier);
}
context.HumanLoopConfig_FlowDefinitionArn = this.HumanLoopConfig_FlowDefinitionArn;
context.HumanLoopConfig_HumanLoopName = this.HumanLoopConfig_HumanLoopName;
if (this.QueriesConfig_Query != null)
{
context.QueriesConfig_Query = new List(this.QueriesConfig_Query);
}
// allow further manipulation of loaded context prior to processing
PostExecutionContextLoad(context);
var output = Execute(context) as CmdletOutput;
ProcessOutput(output);
}
#region IExecutor Members
public object Execute(ExecutorContext context)
{
System.IO.MemoryStream _Document_ByteStream = null;
try
{
var cmdletContext = context as CmdletContext;
// create request
var request = new Amazon.Textract.Model.AnalyzeDocumentRequest();
// populate Document
var requestDocumentIsNull = true;
request.Document = new Amazon.Textract.Model.Document();
System.IO.MemoryStream requestDocument_document_Byte = null;
if (cmdletContext.Document_Byte != null)
{
_Document_ByteStream = new System.IO.MemoryStream(cmdletContext.Document_Byte);
requestDocument_document_Byte = _Document_ByteStream;
}
if (requestDocument_document_Byte != null)
{
request.Document.Bytes = requestDocument_document_Byte;
requestDocumentIsNull = false;
}
Amazon.Textract.Model.S3Object requestDocument_document_S3Object = null;
// populate S3Object
var requestDocument_document_S3ObjectIsNull = true;
requestDocument_document_S3Object = new Amazon.Textract.Model.S3Object();
System.String requestDocument_document_S3Object_s3Object_Bucket = null;
if (cmdletContext.S3Object_Bucket != null)
{
requestDocument_document_S3Object_s3Object_Bucket = cmdletContext.S3Object_Bucket;
}
if (requestDocument_document_S3Object_s3Object_Bucket != null)
{
requestDocument_document_S3Object.Bucket = requestDocument_document_S3Object_s3Object_Bucket;
requestDocument_document_S3ObjectIsNull = false;
}
System.String requestDocument_document_S3Object_s3Object_Name = null;
if (cmdletContext.S3Object_Name != null)
{
requestDocument_document_S3Object_s3Object_Name = cmdletContext.S3Object_Name;
}
if (requestDocument_document_S3Object_s3Object_Name != null)
{
requestDocument_document_S3Object.Name = requestDocument_document_S3Object_s3Object_Name;
requestDocument_document_S3ObjectIsNull = false;
}
System.String requestDocument_document_S3Object_s3Object_Version = null;
if (cmdletContext.S3Object_Version != null)
{
requestDocument_document_S3Object_s3Object_Version = cmdletContext.S3Object_Version;
}
if (requestDocument_document_S3Object_s3Object_Version != null)
{
requestDocument_document_S3Object.Version = requestDocument_document_S3Object_s3Object_Version;
requestDocument_document_S3ObjectIsNull = false;
}
// determine if requestDocument_document_S3Object should be set to null
if (requestDocument_document_S3ObjectIsNull)
{
requestDocument_document_S3Object = null;
}
if (requestDocument_document_S3Object != null)
{
request.Document.S3Object = requestDocument_document_S3Object;
requestDocumentIsNull = false;
}
// determine if request.Document should be set to null
if (requestDocumentIsNull)
{
request.Document = null;
}
if (cmdletContext.FeatureType != null)
{
request.FeatureTypes = cmdletContext.FeatureType;
}
// populate HumanLoopConfig
var requestHumanLoopConfigIsNull = true;
request.HumanLoopConfig = new Amazon.Textract.Model.HumanLoopConfig();
System.String requestHumanLoopConfig_humanLoopConfig_FlowDefinitionArn = null;
if (cmdletContext.HumanLoopConfig_FlowDefinitionArn != null)
{
requestHumanLoopConfig_humanLoopConfig_FlowDefinitionArn = cmdletContext.HumanLoopConfig_FlowDefinitionArn;
}
if (requestHumanLoopConfig_humanLoopConfig_FlowDefinitionArn != null)
{
request.HumanLoopConfig.FlowDefinitionArn = requestHumanLoopConfig_humanLoopConfig_FlowDefinitionArn;
requestHumanLoopConfigIsNull = false;
}
System.String requestHumanLoopConfig_humanLoopConfig_HumanLoopName = null;
if (cmdletContext.HumanLoopConfig_HumanLoopName != null)
{
requestHumanLoopConfig_humanLoopConfig_HumanLoopName = cmdletContext.HumanLoopConfig_HumanLoopName;
}
if (requestHumanLoopConfig_humanLoopConfig_HumanLoopName != null)
{
request.HumanLoopConfig.HumanLoopName = requestHumanLoopConfig_humanLoopConfig_HumanLoopName;
requestHumanLoopConfigIsNull = false;
}
Amazon.Textract.Model.HumanLoopDataAttributes requestHumanLoopConfig_humanLoopConfig_DataAttributes = null;
// populate DataAttributes
var requestHumanLoopConfig_humanLoopConfig_DataAttributesIsNull = true;
requestHumanLoopConfig_humanLoopConfig_DataAttributes = new Amazon.Textract.Model.HumanLoopDataAttributes();
List requestHumanLoopConfig_humanLoopConfig_DataAttributes_dataAttributes_ContentClassifier = null;
if (cmdletContext.DataAttributes_ContentClassifier != null)
{
requestHumanLoopConfig_humanLoopConfig_DataAttributes_dataAttributes_ContentClassifier = cmdletContext.DataAttributes_ContentClassifier;
}
if (requestHumanLoopConfig_humanLoopConfig_DataAttributes_dataAttributes_ContentClassifier != null)
{
requestHumanLoopConfig_humanLoopConfig_DataAttributes.ContentClassifiers = requestHumanLoopConfig_humanLoopConfig_DataAttributes_dataAttributes_ContentClassifier;
requestHumanLoopConfig_humanLoopConfig_DataAttributesIsNull = false;
}
// determine if requestHumanLoopConfig_humanLoopConfig_DataAttributes should be set to null
if (requestHumanLoopConfig_humanLoopConfig_DataAttributesIsNull)
{
requestHumanLoopConfig_humanLoopConfig_DataAttributes = null;
}
if (requestHumanLoopConfig_humanLoopConfig_DataAttributes != null)
{
request.HumanLoopConfig.DataAttributes = requestHumanLoopConfig_humanLoopConfig_DataAttributes;
requestHumanLoopConfigIsNull = false;
}
// determine if request.HumanLoopConfig should be set to null
if (requestHumanLoopConfigIsNull)
{
request.HumanLoopConfig = null;
}
// populate QueriesConfig
var requestQueriesConfigIsNull = true;
request.QueriesConfig = new Amazon.Textract.Model.QueriesConfig();
List requestQueriesConfig_queriesConfig_Query = null;
if (cmdletContext.QueriesConfig_Query != null)
{
requestQueriesConfig_queriesConfig_Query = cmdletContext.QueriesConfig_Query;
}
if (requestQueriesConfig_queriesConfig_Query != null)
{
request.QueriesConfig.Queries = requestQueriesConfig_queriesConfig_Query;
requestQueriesConfigIsNull = false;
}
// determine if request.QueriesConfig should be set to null
if (requestQueriesConfigIsNull)
{
request.QueriesConfig = null;
}
CmdletOutput output;
// issue call
var client = Client ?? CreateClient(_CurrentCredentials, _RegionEndpoint);
try
{
var response = CallAWSServiceOperation(client, request);
object pipelineOutput = null;
pipelineOutput = cmdletContext.Select(response, this);
output = new CmdletOutput
{
PipelineOutput = pipelineOutput,
ServiceResponse = response
};
}
catch (Exception e)
{
output = new CmdletOutput { ErrorResponse = e };
}
return output;
}
finally
{
if( _Document_ByteStream != null)
{
_Document_ByteStream.Dispose();
}
}
}
public ExecutorContext CreateContext()
{
return new CmdletContext();
}
#endregion
#region AWS Service Operation Call
private Amazon.Textract.Model.AnalyzeDocumentResponse CallAWSServiceOperation(IAmazonTextract client, Amazon.Textract.Model.AnalyzeDocumentRequest request)
{
Utils.Common.WriteVerboseEndpointMessage(this, client.Config, "Amazon Textract", "AnalyzeDocument");
try
{
#if DESKTOP
return client.AnalyzeDocument(request);
#elif CORECLR
return client.AnalyzeDocumentAsync(request).GetAwaiter().GetResult();
#else
#error "Unknown build edition"
#endif
}
catch (AmazonServiceException exc)
{
var webException = exc.InnerException as System.Net.WebException;
if (webException != null)
{
throw new Exception(Utils.Common.FormatNameResolutionFailureMessage(client.Config, webException.Message), webException);
}
throw;
}
}
#endregion
internal partial class CmdletContext : ExecutorContext
{
public byte[] Document_Byte { get; set; }
public System.String S3Object_Bucket { get; set; }
public System.String S3Object_Name { get; set; }
public System.String S3Object_Version { get; set; }
public List FeatureType { get; set; }
public List DataAttributes_ContentClassifier { get; set; }
public System.String HumanLoopConfig_FlowDefinitionArn { get; set; }
public System.String HumanLoopConfig_HumanLoopName { get; set; }
public List QueriesConfig_Query { get; set; }
public System.Func Select { get; set; } =
(response, cmdlet) => response.Blocks;
}
}
}