Namespace Google.Apis.Document.v1
Classes
DocumentBaseServiceRequest<TResponse>
A base abstract class for Document requests.
DocumentService
The Document Service.
DocumentService.Scope
Available OAuth 2.0 scopes for use with the Cloud Document AI API.
DocumentService.ScopeConstants
Available OAuth 2.0 scope constants for use with the Cloud Document AI API.
OperationsResource
The "operations" collection of methods.
OperationsResource.DeleteRequest
Deletes a long-running operation. This method indicates that the client is no longer interested in the
operation result. It does not cancel the operation. If the server doesn't support this method, it returns
google.rpc.Code.UNIMPLEMENTED
.
ProjectsResource
The "projects" collection of methods.
ProjectsResource.LocationsResource
The "locations" collection of methods.
ProjectsResource.LocationsResource.FetchProcessorTypesRequest
Fetches processor types. Note that we don't use ListProcessorTypes here, because it isn't paginated.
ProjectsResource.LocationsResource.GetRequest
Gets information about a location.
ProjectsResource.LocationsResource.ListRequest
Lists information about the supported locations for this service.
ProjectsResource.LocationsResource.OperationsResource
The "operations" collection of methods.
ProjectsResource.LocationsResource.OperationsResource.CancelRequest
Starts asynchronous cancellation on a long-running operation. The server makes a best effort to
cancel the operation, but success is not guaranteed. If the server doesn't support this method, it
returns google.rpc.Code.UNIMPLEMENTED
. Clients can use Operations.GetOperation or other methods to
check whether the cancellation succeeded or whether the operation completed despite cancellation. On
successful cancellation, the operation is not deleted; instead, it becomes an operation with an
Operation.error value with a google.rpc.Status.code of 1, corresponding to Code.CANCELLED
.
ProjectsResource.LocationsResource.OperationsResource.GetRequest
Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.
ProjectsResource.LocationsResource.OperationsResource.ListRequest
Lists operations that match the specified filter in the request. If the server doesn't support this
method, it returns UNIMPLEMENTED
.
ProjectsResource.LocationsResource.ProcessorTypesResource
The "processorTypes" collection of methods.
ProjectsResource.LocationsResource.ProcessorTypesResource.GetRequest
Gets a processor type detail.
ProjectsResource.LocationsResource.ProcessorTypesResource.ListRequest
Lists the processor types that exist.
ProjectsResource.LocationsResource.ProcessorsResource
The "processors" collection of methods.
ProjectsResource.LocationsResource.ProcessorsResource.BatchProcessRequest
LRO endpoint to batch process many documents. The output is written to Cloud Storage as JSON in the [Document] format.
ProjectsResource.LocationsResource.ProcessorsResource.CreateRequest
Creates a processor from the ProcessorType provided. The processor will be at ENABLED
state by
default after its creation. Note that this method requires the documentai.processors.create
permission on the project, which is highly privileged. A user or service account with this
permission can create new processors that can interact with any gcs bucket in your project.
ProjectsResource.LocationsResource.ProcessorsResource.DeleteRequest
Deletes the processor, unloads all deployed model artifacts if it was enabled and then deletes all artifacts associated with this processor.
ProjectsResource.LocationsResource.ProcessorsResource.DisableRequest
Disables a processor
ProjectsResource.LocationsResource.ProcessorsResource.EnableRequest
Enables a processor
ProjectsResource.LocationsResource.ProcessorsResource.GetRequest
Gets a processor detail.
ProjectsResource.LocationsResource.ProcessorsResource.HumanReviewConfigResource
The "humanReviewConfig" collection of methods.
ProjectsResource.LocationsResource.ProcessorsResource.HumanReviewConfigResource.ReviewDocumentRequest
Send a document for Human Review. The input document should be processed by the specified processor.
ProjectsResource.LocationsResource.ProcessorsResource.ListRequest
Lists all processors which belong to this project.
ProjectsResource.LocationsResource.ProcessorsResource.ProcessRequest
Processes a single document.
ProjectsResource.LocationsResource.ProcessorsResource.ProcessorVersionsResource
The "processorVersions" collection of methods.
ProjectsResource.LocationsResource.ProcessorsResource.ProcessorVersionsResource.BatchProcessRequest
LRO endpoint to batch process many documents. The output is written to Cloud Storage as JSON in the [Document] format.
ProjectsResource.LocationsResource.ProcessorsResource.ProcessorVersionsResource.DeleteRequest
Deletes the processor version, all artifacts under the processor version will be deleted.
ProjectsResource.LocationsResource.ProcessorsResource.ProcessorVersionsResource.DeployRequest
Deploys the processor version.
ProjectsResource.LocationsResource.ProcessorsResource.ProcessorVersionsResource.EvaluateProcessorVersionRequest
Evaluates a ProcessorVersion against annotated documents, producing an Evaluation.
ProjectsResource.LocationsResource.ProcessorsResource.ProcessorVersionsResource.EvaluationsResource
The "evaluations" collection of methods.
ProjectsResource.LocationsResource.ProcessorsResource.ProcessorVersionsResource.EvaluationsResource.GetRequest
Retrieves a specific evaluation.
ProjectsResource.LocationsResource.ProcessorsResource.ProcessorVersionsResource.EvaluationsResource.ListRequest
Retrieves a set of evaluations for a given processor version.
ProjectsResource.LocationsResource.ProcessorsResource.ProcessorVersionsResource.GetRequest
Gets a processor version detail.
ProjectsResource.LocationsResource.ProcessorsResource.ProcessorVersionsResource.ListRequest
Lists all versions of a processor.
ProjectsResource.LocationsResource.ProcessorsResource.ProcessorVersionsResource.ProcessRequest
Processes a single document.
ProjectsResource.LocationsResource.ProcessorsResource.ProcessorVersionsResource.TrainRequest
Trains a new processor version. Operation metadata is returned as TrainProcessorVersionMetadata.
ProjectsResource.LocationsResource.ProcessorsResource.ProcessorVersionsResource.UndeployRequest
Undeploys the processor version.
ProjectsResource.LocationsResource.ProcessorsResource.SetDefaultProcessorVersionRequest
Set the default (active) version of a Processor that will be used in ProcessDocument and BatchProcessDocuments.
ProjectsResource.OperationsResource
The "operations" collection of methods.
ProjectsResource.OperationsResource.GetRequest
Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.
Enums
DocumentBaseServiceRequest<TResponse>.AltEnum
Data format for response.
DocumentBaseServiceRequest<TResponse>.XgafvEnum
V1 error format.