Class ProjectsResource.LocationsResource.ProcessorsResource.ProcessorVersionsResource

The "processorVersions" collection of methods.

Inheritance

object

ProjectsResource.LocationsResource.ProcessorsResource.ProcessorVersionsResource

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

object.ToString()

Namespace: Google.Apis.Document.v1

Assembly: Google.Apis.Document.v1.dll

Syntax

public class ProjectsResource.LocationsResource.ProcessorsResource.ProcessorVersionsResource

Constructors

ProcessorVersionsResource(IClientService)

Constructs a new resource.

Declaration

public ProcessorVersionsResource(IClientService service)

Parameters

Type	Name	Description
IClientService	service

Properties

Evaluations

Gets the Evaluations resource.

Declaration

public virtual ProjectsResource.LocationsResource.ProcessorsResource.ProcessorVersionsResource.EvaluationsResource Evaluations { get; }

Property Value

Type	Description
ProjectsResource.LocationsResource.ProcessorsResource.ProcessorVersionsResource.EvaluationsResource

Methods

BatchProcess(GoogleCloudDocumentaiV1BatchProcessRequest, string)

LRO endpoint to batch process many documents. The output is written to Cloud Storage as JSON in the [Document] format.

Declaration

public virtual ProjectsResource.LocationsResource.ProcessorsResource.ProcessorVersionsResource.BatchProcessRequest BatchProcess(GoogleCloudDocumentaiV1BatchProcessRequest body, string name)

Parameters

Type	Name	Description
GoogleCloudDocumentaiV1BatchProcessRequest	body	The body of the request.
string	name	Required. The resource name of Processor or ProcessorVersion. Format: projects/{project}/locations/{location}/processors/{processor}, or projects/{project}/locations/{location}/processors/{processor}/processorVersions/{processorVersion}

Returns

Type	Description
ProjectsResource.LocationsResource.ProcessorsResource.ProcessorVersionsResource.BatchProcessRequest

Delete(string)

Deletes the processor version, all artifacts under the processor version will be deleted.

Declaration

public virtual ProjectsResource.LocationsResource.ProcessorsResource.ProcessorVersionsResource.DeleteRequest Delete(string name)

Parameters

Type	Name	Description
string	name	Required. The processor version resource name to be deleted.

Returns

Type	Description
ProjectsResource.LocationsResource.ProcessorsResource.ProcessorVersionsResource.DeleteRequest

Deploy(GoogleCloudDocumentaiV1DeployProcessorVersionRequest, string)

Deploys the processor version.

Declaration

public virtual ProjectsResource.LocationsResource.ProcessorsResource.ProcessorVersionsResource.DeployRequest Deploy(GoogleCloudDocumentaiV1DeployProcessorVersionRequest body, string name)

Parameters

Type	Name	Description
GoogleCloudDocumentaiV1DeployProcessorVersionRequest	body	The body of the request.
string	name	Required. The processor version resource name to be deployed.

Returns

Type	Description
ProjectsResource.LocationsResource.ProcessorsResource.ProcessorVersionsResource.DeployRequest

EvaluateProcessorVersion(GoogleCloudDocumentaiV1EvaluateProcessorVersionRequest, string)

Evaluates a ProcessorVersion against annotated documents, producing an Evaluation.

Declaration

public virtual ProjectsResource.LocationsResource.ProcessorsResource.ProcessorVersionsResource.EvaluateProcessorVersionRequest EvaluateProcessorVersion(GoogleCloudDocumentaiV1EvaluateProcessorVersionRequest body, string processorVersion)

Parameters

Type	Name	Description
GoogleCloudDocumentaiV1EvaluateProcessorVersionRequest	body	The body of the request.
string	processorVersion	Required. The resource name of the ProcessorVersion to evaluate. projects/{project}/locations/{location}/processors/{processor}/processorVersions/{processorVersion}

Returns

Type	Description
ProjectsResource.LocationsResource.ProcessorsResource.ProcessorVersionsResource.EvaluateProcessorVersionRequest

Get(string)

Gets a processor version detail.

Declaration

public virtual ProjectsResource.LocationsResource.ProcessorsResource.ProcessorVersionsResource.GetRequest Get(string name)

Parameters

Type	Name	Description
string	name	Required. The processor resource name.

Returns

Type	Description
ProjectsResource.LocationsResource.ProcessorsResource.ProcessorVersionsResource.GetRequest

List(string)

Lists all versions of a processor.

Declaration

public virtual ProjectsResource.LocationsResource.ProcessorsResource.ProcessorVersionsResource.ListRequest List(string parent)

Parameters

Type	Name	Description
string	parent	Required. The parent (project, location and processor) to list all versions. Format: projects/{project}/locations/{location}/processors/{processor}

Returns

Type	Description
ProjectsResource.LocationsResource.ProcessorsResource.ProcessorVersionsResource.ListRequest

Process(GoogleCloudDocumentaiV1ProcessRequest, string)

Processes a single document.

Declaration

public virtual ProjectsResource.LocationsResource.ProcessorsResource.ProcessorVersionsResource.ProcessRequest Process(GoogleCloudDocumentaiV1ProcessRequest body, string name)

Parameters

Type	Name	Description
GoogleCloudDocumentaiV1ProcessRequest	body	The body of the request.
string	name	Required. The resource name of the Processor or ProcessorVersion to use for processing. If a Processor is specified, the server will use its default version. Format: projects/{project}/locations/{location}/processors/{processor}, or projects/{project}/locations/{location}/processors/{processor}/processorVersions/{processorVersion}

Returns

Type	Description
ProjectsResource.LocationsResource.ProcessorsResource.ProcessorVersionsResource.ProcessRequest

Train(GoogleCloudDocumentaiV1TrainProcessorVersionRequest, string)

Trains a new processor version. Operation metadata is returned as TrainProcessorVersionMetadata.

Declaration

public virtual ProjectsResource.LocationsResource.ProcessorsResource.ProcessorVersionsResource.TrainRequest Train(GoogleCloudDocumentaiV1TrainProcessorVersionRequest body, string parent)

Parameters

Type	Name	Description
GoogleCloudDocumentaiV1TrainProcessorVersionRequest	body	The body of the request.
string	parent	Required. The parent (project, location and processor) to create the new version for. Format: projects/{project}/locations/{location}/processors/{processor}.

Returns

Type	Description
ProjectsResource.LocationsResource.ProcessorsResource.ProcessorVersionsResource.TrainRequest

Undeploy(GoogleCloudDocumentaiV1UndeployProcessorVersionRequest, string)

Undeploys the processor version.

Declaration

public virtual ProjectsResource.LocationsResource.ProcessorsResource.ProcessorVersionsResource.UndeployRequest Undeploy(GoogleCloudDocumentaiV1UndeployProcessorVersionRequest body, string name)

Parameters

Type	Name	Description
GoogleCloudDocumentaiV1UndeployProcessorVersionRequest	body	The body of the request.
string	name	Required. The processor version resource name to be undeployed.

Returns

Type	Description
ProjectsResource.LocationsResource.ProcessorsResource.ProcessorVersionsResource.UndeployRequest