Struct google_api_proto::google::cloud::documentai::v1beta3::document_processor_service_client::DocumentProcessorServiceClient

pub struct DocumentProcessorServiceClient<T> { /* private fields */ }

Service to call Document AI to process documents according to the processor’s definition. Processors are built using state-of-the-art Google AI such as natural language, computer vision, and translation to extract structured information from unstructured or semi-structured documents.

Implementations

impl<T> DocumentProcessorServiceClient<T>

where T: GrpcService<BoxBody>, T::Error: Into<StdError>, T::ResponseBody: Body<Data = Bytes> + Send + 'static, <T::ResponseBody as Body>::Error: Into<StdError> + Send,

pub fn new(inner: T) -> Self

pub fn with_origin(inner: T, origin: Uri) -> Self

pub fn with_interceptor<F>( inner: T, interceptor: F ) -> DocumentProcessorServiceClient<InterceptedService<T, F>>

where F: Interceptor, T::ResponseBody: Default, T: Service<Request<BoxBody>, Response = Response<<T as GrpcService<BoxBody>>::ResponseBody>>, <T as Service<Request<BoxBody>>>::Error: Into<StdError> + Send + Sync,

pub fn send_compressed(self, encoding: CompressionEncoding) -> Self

Compress requests with the given encoding.

This requires the server to support it otherwise it might respond with an error.

pub fn accept_compressed(self, encoding: CompressionEncoding) -> Self

Enable decompressing responses.

pub fn max_decoding_message_size(self, limit: usize) -> Self

Limits the maximum size of a decoded message.

Default: 4MB

pub fn max_encoding_message_size(self, limit: usize) -> Self

Limits the maximum size of an encoded message.

Default: usize::MAX

pub async fn process_document( &mut self, request: impl IntoRequest<ProcessRequest> ) -> Result<Response<ProcessResponse>, Status>

Processes a single document.

pub async fn batch_process_documents( &mut self, request: impl IntoRequest<BatchProcessRequest> ) -> Result<Response<Operation>, Status>

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

pub async fn fetch_processor_types( &mut self, request: impl IntoRequest<FetchProcessorTypesRequest> ) -> Result<Response<FetchProcessorTypesResponse>, Status>

Fetches processor types. Note that we don’t use [ListProcessorTypes][google.cloud.documentai.v1beta3.DocumentProcessorService.ListProcessorTypes] here, because it isn’t paginated.

pub async fn list_processor_types( &mut self, request: impl IntoRequest<ListProcessorTypesRequest> ) -> Result<Response<ListProcessorTypesResponse>, Status>

Lists the processor types that exist.

pub async fn get_processor_type( &mut self, request: impl IntoRequest<GetProcessorTypeRequest> ) -> Result<Response<ProcessorType>, Status>

Gets a processor type detail.

pub async fn list_processors( &mut self, request: impl IntoRequest<ListProcessorsRequest> ) -> Result<Response<ListProcessorsResponse>, Status>

Lists all processors which belong to this project.

pub async fn get_processor( &mut self, request: impl IntoRequest<GetProcessorRequest> ) -> Result<Response<Processor>, Status>

Gets a processor detail.

pub async fn train_processor_version( &mut self, request: impl IntoRequest<TrainProcessorVersionRequest> ) -> Result<Response<Operation>, Status>

Trains a new processor version. Operation metadata is returned as [TrainProcessorVersionMetadata][google.cloud.documentai.v1beta3.TrainProcessorVersionMetadata].

pub async fn get_processor_version( &mut self, request: impl IntoRequest<GetProcessorVersionRequest> ) -> Result<Response<ProcessorVersion>, Status>

Gets a processor version detail.

pub async fn list_processor_versions( &mut self, request: impl IntoRequest<ListProcessorVersionsRequest> ) -> Result<Response<ListProcessorVersionsResponse>, Status>

Lists all versions of a processor.

pub async fn delete_processor_version( &mut self, request: impl IntoRequest<DeleteProcessorVersionRequest> ) -> Result<Response<Operation>, Status>

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

pub async fn deploy_processor_version( &mut self, request: impl IntoRequest<DeployProcessorVersionRequest> ) -> Result<Response<Operation>, Status>

Deploys the processor version.

pub async fn undeploy_processor_version( &mut self, request: impl IntoRequest<UndeployProcessorVersionRequest> ) -> Result<Response<Operation>, Status>

Undeploys the processor version.

pub async fn create_processor( &mut self, request: impl IntoRequest<CreateProcessorRequest> ) -> Result<Response<Processor>, Status>

Creates a processor from the [ProcessorType][google.cloud.documentai.v1beta3.ProcessorType] provided. The processor will be at ENABLED state by default after its creation.

pub async fn delete_processor( &mut self, request: impl IntoRequest<DeleteProcessorRequest> ) -> Result<Response<Operation>, Status>

Deletes the processor, unloads all deployed model artifacts if it was enabled and then deletes all artifacts associated with this processor.

pub async fn enable_processor( &mut self, request: impl IntoRequest<EnableProcessorRequest> ) -> Result<Response<Operation>, Status>

Enables a processor

pub async fn disable_processor( &mut self, request: impl IntoRequest<DisableProcessorRequest> ) -> Result<Response<Operation>, Status>

Disables a processor

pub async fn set_default_processor_version( &mut self, request: impl IntoRequest<SetDefaultProcessorVersionRequest> ) -> Result<Response<Operation>, Status>

Set the default (active) version of a [Processor][google.cloud.documentai.v1beta3.Processor] that will be used in [ProcessDocument][google.cloud.documentai.v1beta3.DocumentProcessorService.ProcessDocument] and [BatchProcessDocuments][google.cloud.documentai.v1beta3.DocumentProcessorService.BatchProcessDocuments].

pub async fn review_document( &mut self, request: impl IntoRequest<ReviewDocumentRequest> ) -> Result<Response<Operation>, Status>

Send a document for Human Review. The input document should be processed by the specified processor.

pub async fn evaluate_processor_version( &mut self, request: impl IntoRequest<EvaluateProcessorVersionRequest> ) -> Result<Response<Operation>, Status>

Evaluates a ProcessorVersion against annotated documents, producing an Evaluation.

pub async fn get_evaluation( &mut self, request: impl IntoRequest<GetEvaluationRequest> ) -> Result<Response<Evaluation>, Status>

Retrieves a specific evaluation.

pub async fn list_evaluations( &mut self, request: impl IntoRequest<ListEvaluationsRequest> ) -> Result<Response<ListEvaluationsResponse>, Status>

Retrieves a set of evaluations for a given processor version.

pub async fn import_processor_version( &mut self, request: impl IntoRequest<ImportProcessorVersionRequest> ) -> Result<Response<Operation>, Status>

Imports a processor version from source processor version.

Trait Implementations

impl<T: Clone> Clone for DocumentProcessorServiceClient<T>

fn clone(&self) -> DocumentProcessorServiceClient<T>

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl<T: Debug> Debug for DocumentProcessorServiceClient<T>

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.