Cloud Document AI v1beta3 API - Class DocumentService.DocumentServiceBase (2.0.0-beta23)

[BindServiceMethod(typeof(DocumentService), "BindService")]
public abstract class DocumentService.DocumentServiceBase

Reference documentation and code samples for the Cloud Document AI v1beta3 API class DocumentService.DocumentServiceBase.

Base class for server-side implementations of DocumentService

Inheritance

object > DocumentService.DocumentServiceBase

Inherited Members

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ToString()

Namespace

Google.Cloud.DocumentAI.V1Beta3

Assembly

Google.Cloud.DocumentAI.V1Beta3.dll

Methods

BatchDeleteDocuments(BatchDeleteDocumentsRequest, ServerCallContext)

public virtual Task<Operation> BatchDeleteDocuments(BatchDeleteDocumentsRequest request, ServerCallContext context)

Deletes a set of documents.

Parameters
Name	Description
`request`	`BatchDeleteDocumentsRequest` The request received from the client.
`context`	`ServerCallContext` The context of the server-side call handler being invoked.

Returns
Type	Description
`TaskOperation`	The response to send back to the client (wrapped by a task).

GetDatasetSchema(GetDatasetSchemaRequest, ServerCallContext)

public virtual Task<DatasetSchema> GetDatasetSchema(GetDatasetSchemaRequest request, ServerCallContext context)

Gets the DatasetSchema of a Dataset.

Parameters
Name	Description
`request`	`GetDatasetSchemaRequest` The request received from the client.
`context`	`ServerCallContext` The context of the server-side call handler being invoked.

Returns
Type	Description
`TaskDatasetSchema`	The response to send back to the client (wrapped by a task).

GetDocument(GetDocumentRequest, ServerCallContext)

public virtual Task<GetDocumentResponse> GetDocument(GetDocumentRequest request, ServerCallContext context)

Returns relevant fields present in the requested document.

Parameters
Name	Description
`request`	`GetDocumentRequest` The request received from the client.
`context`	`ServerCallContext` The context of the server-side call handler being invoked.

Returns
Type	Description
`TaskGetDocumentResponse`	The response to send back to the client (wrapped by a task).

ImportDocuments(ImportDocumentsRequest, ServerCallContext)

public virtual Task<Operation> ImportDocuments(ImportDocumentsRequest request, ServerCallContext context)

Import documents into a dataset.

Parameters
Name	Description
`request`	`ImportDocumentsRequest` The request received from the client.
`context`	`ServerCallContext` The context of the server-side call handler being invoked.

Returns
Type	Description
`TaskOperation`	The response to send back to the client (wrapped by a task).

ListDocuments(ListDocumentsRequest, ServerCallContext)

public virtual Task<ListDocumentsResponse> ListDocuments(ListDocumentsRequest request, ServerCallContext context)

Returns a list of documents present in the dataset.

Parameters
Name	Description
`request`	`ListDocumentsRequest` The request received from the client.
`context`	`ServerCallContext` The context of the server-side call handler being invoked.

Returns
Type	Description
`TaskListDocumentsResponse`	The response to send back to the client (wrapped by a task).

UpdateDataset(UpdateDatasetRequest, ServerCallContext)

public virtual Task<Operation> UpdateDataset(UpdateDatasetRequest request, ServerCallContext context)

Updates metadata associated with a dataset. Note that this method requires the documentai.googleapis.com/datasets.update 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.

Parameters
Name	Description
`request`	`UpdateDatasetRequest` The request received from the client.
`context`	`ServerCallContext` The context of the server-side call handler being invoked.

Returns
Type	Description
`TaskOperation`	The response to send back to the client (wrapped by a task).

UpdateDatasetSchema(UpdateDatasetSchemaRequest, ServerCallContext)

public virtual Task<DatasetSchema> UpdateDatasetSchema(UpdateDatasetSchemaRequest request, ServerCallContext context)

Updates a DatasetSchema.

Parameters
Name	Description
`request`	`UpdateDatasetSchemaRequest` The request received from the client.
`context`	`ServerCallContext` The context of the server-side call handler being invoked.

Returns
Type	Description
`TaskDatasetSchema`	The response to send back to the client (wrapped by a task).