Package documentai is an auto-generated package for the Cloud Document AI API.
Service to parse structured information from unstructured or semi-structured documents using state-of-the-art Google AI such as natural language, computer vision, translation, and AutoML.
NOTE : This package is in beta . It is not stable , and may be subject to changes .
General documentation
For information that is relevant for all client libraries please reference https://pkg.go.dev/cloud.google.com/go#pkg-overview . Some information on this page includes:
- Authentication and Authorization
- Timeouts and Cancellation
- Testing against Client Libraries
- Debugging Client Libraries
- Inspecting errors
Example usage
To get started with this package, create a client.
ctx := context . Background () // This snippet has been automatically generated and should be regarded as a code template only. // It will require modifications to work: // - It may require correct/in-range values for request initialization. // - It may require specifying regional endpoints when creating the service client as shown in: // https://pkg.go.dev/cloud.google.com/go#hdr-Client_Options c , err := documentai . NewDocumentProcessorClient ( ctx ) if err != nil { // TODO: Handle error. } defer c . Close ()
The client will use your default application credentials. Clients should be reused instead of created as needed. The methods of Client are safe for concurrent use by multiple goroutines. The returned client must be Closed when it is done being used.
Using the Client
The following is an example of making an API call with the newly created client.
ctx := context . Background () // This snippet has been automatically generated and should be regarded as a code template only. // It will require modifications to work: // - It may require correct/in-range values for request initialization. // - It may require specifying regional endpoints when creating the service client as shown in: // https://pkg.go.dev/cloud.google.com/go#hdr-Client_Options c , err := documentai . NewDocumentProcessorClient ( ctx ) if err != nil { // TODO: Handle error. } defer c . Close () req := & documentaipb . BatchProcessRequest { // TODO: Fill request struct fields. // See https://pkg.go.dev/cloud.google.com/go/documentai/apiv1beta3/documentaipb#BatchProcessRequest. } op , err := c . BatchProcessDocuments ( ctx , req ) if err != nil { // TODO: Handle error. } resp , err := op . Wait ( ctx ) if err != nil { // TODO: Handle error. } // TODO: Use resp. _ = resp
Use of Context
The ctx passed to NewDocumentProcessorClient is used for authentication requests and for creating the underlying connection, but is not used for subsequent calls. Individual methods on the client use the ctx given to them.
To close the open connection, use the Close() method.
Functions
func DefaultAuthScopes
func
DefaultAuthScopes
()
[]
string
DefaultAuthScopes reports the default set of authentication scopes to use with this package.
BatchDeleteDocumentsOperation
type
BatchDeleteDocumentsOperation
struct
{
// contains filtered or unexported fields
}
BatchDeleteDocumentsOperation manages a long-running operation from BatchDeleteDocuments.
func (*BatchDeleteDocumentsOperation) Done
func
(
op
*
BatchDeleteDocumentsOperation
)
Done
()
bool
Done reports whether the long-running operation has completed.
func (*BatchDeleteDocumentsOperation) Metadata
func
(
op
*
BatchDeleteDocumentsOperation
)
Metadata
()
(
*
documentaipb
.
BatchDeleteDocumentsMetadata
,
error
)
Metadata returns metadata associated with the long-running operation. Metadata itself does not contact the server, but Poll does. To get the latest metadata, call this method after a successful call to Poll. If the metadata is not available, the returned metadata and error are both nil.
func (*BatchDeleteDocumentsOperation) Name
func
(
op
*
BatchDeleteDocumentsOperation
)
Name
()
string
Name returns the name of the long-running operation. The name is assigned by the server and is unique within the service from which the operation is created.
func (*BatchDeleteDocumentsOperation) Poll
func
(
op
*
BatchDeleteDocumentsOperation
)
Poll
(
ctx
context
.
Context
,
opts
...
gax
.
CallOption
)
(
*
documentaipb
.
BatchDeleteDocumentsResponse
,
error
)
Poll fetches the latest state of the long-running operation.
Poll also fetches the latest metadata, which can be retrieved by Metadata.
If Poll fails, the error is returned and op is unmodified. If Poll succeeds and the operation has completed with failure, the error is returned and op.Done will return true. If Poll succeeds and the operation has completed successfully, op.Done will return true, and the response of the operation is returned. If Poll succeeds and the operation has not completed, the returned response and error are both nil.
func (*BatchDeleteDocumentsOperation) Wait
func
(
op
*
BatchDeleteDocumentsOperation
)
Wait
(
ctx
context
.
Context
,
opts
...
gax
.
CallOption
)
(
*
documentaipb
.
BatchDeleteDocumentsResponse
,
error
)
Wait blocks until the long-running operation is completed, returning the response and any errors encountered.
See documentation of Poll for error-handling information.
BatchProcessDocumentsOperation
type
BatchProcessDocumentsOperation
struct
{
// contains filtered or unexported fields
}
BatchProcessDocumentsOperation manages a long-running operation from BatchProcessDocuments.
func (*BatchProcessDocumentsOperation) Done
func
(
op
*
BatchProcessDocumentsOperation
)
Done
()
bool
Done reports whether the long-running operation has completed.
func (*BatchProcessDocumentsOperation) Metadata
func
(
op
*
BatchProcessDocumentsOperation
)
Metadata
()
(
*
documentaipb
.
BatchProcessMetadata
,
error
)
Metadata returns metadata associated with the long-running operation. Metadata itself does not contact the server, but Poll does. To get the latest metadata, call this method after a successful call to Poll. If the metadata is not available, the returned metadata and error are both nil.
func (*BatchProcessDocumentsOperation) Name
func
(
op
*
BatchProcessDocumentsOperation
)
Name
()
string
Name returns the name of the long-running operation. The name is assigned by the server and is unique within the service from which the operation is created.
func (*BatchProcessDocumentsOperation) Poll
func
(
op
*
BatchProcessDocumentsOperation
)
Poll
(
ctx
context
.
Context
,
opts
...
gax
.
CallOption
)
(
*
documentaipb
.
BatchProcessResponse
,
error
)
Poll fetches the latest state of the long-running operation.
Poll also fetches the latest metadata, which can be retrieved by Metadata.
If Poll fails, the error is returned and op is unmodified. If Poll succeeds and the operation has completed with failure, the error is returned and op.Done will return true. If Poll succeeds and the operation has completed successfully, op.Done will return true, and the response of the operation is returned. If Poll succeeds and the operation has not completed, the returned response and error are both nil.
func (*BatchProcessDocumentsOperation) Wait
func
(
op
*
BatchProcessDocumentsOperation
)
Wait
(
ctx
context
.
Context
,
opts
...
gax
.
CallOption
)
(
*
documentaipb
.
BatchProcessResponse
,
error
)
Wait blocks until the long-running operation is completed, returning the response and any errors encountered.
See documentation of Poll for error-handling information.
DeleteProcessorOperation
type
DeleteProcessorOperation
struct
{
// contains filtered or unexported fields
}
DeleteProcessorOperation manages a long-running operation from DeleteProcessor.
func (*DeleteProcessorOperation) Done
func
(
op
*
DeleteProcessorOperation
)
Done
()
bool
Done reports whether the long-running operation has completed.
func (*DeleteProcessorOperation) Metadata
func
(
op
*
DeleteProcessorOperation
)
Metadata
()
(
*
documentaipb
.
DeleteProcessorMetadata
,
error
)
Metadata returns metadata associated with the long-running operation. Metadata itself does not contact the server, but Poll does. To get the latest metadata, call this method after a successful call to Poll. If the metadata is not available, the returned metadata and error are both nil.
func (*DeleteProcessorOperation) Name
func
(
op
*
DeleteProcessorOperation
)
Name
()
string
Name returns the name of the long-running operation. The name is assigned by the server and is unique within the service from which the operation is created.
func (*DeleteProcessorOperation) Poll
func
(
op
*
DeleteProcessorOperation
)
Poll
(
ctx
context
.
Context
,
opts
...
gax
.
CallOption
)
error
Poll fetches the latest state of the long-running operation.
Poll also fetches the latest metadata, which can be retrieved by Metadata.
If Poll fails, the error is returned and op is unmodified. If Poll succeeds and the operation has completed with failure, the error is returned and op.Done will return true. If Poll succeeds and the operation has completed successfully, op.Done will return true, and the response of the operation is returned. If Poll succeeds and the operation has not completed, the returned response and error are both nil.
func (*DeleteProcessorOperation) Wait
func
(
op
*
DeleteProcessorOperation
)
Wait
(
ctx
context
.
Context
,
opts
...
gax
.
CallOption
)
error
Wait blocks until the long-running operation is completed, returning the response and any errors encountered.
See documentation of Poll for error-handling information.
DeleteProcessorVersionOperation
type
DeleteProcessorVersionOperation
struct
{
// contains filtered or unexported fields
}
DeleteProcessorVersionOperation manages a long-running operation from DeleteProcessorVersion.
func (*DeleteProcessorVersionOperation) Done
func
(
op
*
DeleteProcessorVersionOperation
)
Done
()
bool
Done reports whether the long-running operation has completed.
func (*DeleteProcessorVersionOperation) Metadata
func
(
op
*
DeleteProcessorVersionOperation
)
Metadata
()
(
*
documentaipb
.
DeleteProcessorVersionMetadata
,
error
)
Metadata returns metadata associated with the long-running operation. Metadata itself does not contact the server, but Poll does. To get the latest metadata, call this method after a successful call to Poll. If the metadata is not available, the returned metadata and error are both nil.
func (*DeleteProcessorVersionOperation) Name
func
(
op
*
DeleteProcessorVersionOperation
)
Name
()
string
Name returns the name of the long-running operation. The name is assigned by the server and is unique within the service from which the operation is created.
func (*DeleteProcessorVersionOperation) Poll
func
(
op
*
DeleteProcessorVersionOperation
)
Poll
(
ctx
context
.
Context
,
opts
...
gax
.
CallOption
)
error
Poll fetches the latest state of the long-running operation.
Poll also fetches the latest metadata, which can be retrieved by Metadata.
If Poll fails, the error is returned and op is unmodified. If Poll succeeds and the operation has completed with failure, the error is returned and op.Done will return true. If Poll succeeds and the operation has completed successfully, op.Done will return true, and the response of the operation is returned. If Poll succeeds and the operation has not completed, the returned response and error are both nil.
func (*DeleteProcessorVersionOperation) Wait
func
(
op
*
DeleteProcessorVersionOperation
)
Wait
(
ctx
context
.
Context
,
opts
...
gax
.
CallOption
)
error
Wait blocks until the long-running operation is completed, returning the response and any errors encountered.
See documentation of Poll for error-handling information.
DeployProcessorVersionOperation
type
DeployProcessorVersionOperation
struct
{
// contains filtered or unexported fields
}
DeployProcessorVersionOperation manages a long-running operation from DeployProcessorVersion.
func (*DeployProcessorVersionOperation) Done
func
(
op
*
DeployProcessorVersionOperation
)
Done
()
bool
Done reports whether the long-running operation has completed.
func (*DeployProcessorVersionOperation) Metadata
func
(
op
*
DeployProcessorVersionOperation
)
Metadata
()
(
*
documentaipb
.
DeployProcessorVersionMetadata
,
error
)
Metadata returns metadata associated with the long-running operation. Metadata itself does not contact the server, but Poll does. To get the latest metadata, call this method after a successful call to Poll. If the metadata is not available, the returned metadata and error are both nil.
func (*DeployProcessorVersionOperation) Name
func
(
op
*
DeployProcessorVersionOperation
)
Name
()
string
Name returns the name of the long-running operation. The name is assigned by the server and is unique within the service from which the operation is created.
func (*DeployProcessorVersionOperation) Poll
func
(
op
*
DeployProcessorVersionOperation
)
Poll
(
ctx
context
.
Context
,
opts
...
gax
.
CallOption
)
(
*
documentaipb
.
DeployProcessorVersionResponse
,
error
)
Poll fetches the latest state of the long-running operation.
Poll also fetches the latest metadata, which can be retrieved by Metadata.
If Poll fails, the error is returned and op is unmodified. If Poll succeeds and the operation has completed with failure, the error is returned and op.Done will return true. If Poll succeeds and the operation has completed successfully, op.Done will return true, and the response of the operation is returned. If Poll succeeds and the operation has not completed, the returned response and error are both nil.
func (*DeployProcessorVersionOperation) Wait
func
(
op
*
DeployProcessorVersionOperation
)
Wait
(
ctx
context
.
Context
,
opts
...
gax
.
CallOption
)
(
*
documentaipb
.
DeployProcessorVersionResponse
,
error
)
Wait blocks until the long-running operation is completed, returning the response and any errors encountered.
See documentation of Poll for error-handling information.
DisableProcessorOperation
type
DisableProcessorOperation
struct
{
// contains filtered or unexported fields
}
DisableProcessorOperation manages a long-running operation from DisableProcessor.
func (*DisableProcessorOperation) Done
func
(
op
*
DisableProcessorOperation
)
Done
()
bool
Done reports whether the long-running operation has completed.
func (*DisableProcessorOperation) Metadata
func
(
op
*
DisableProcessorOperation
)
Metadata
()
(
*
documentaipb
.
DisableProcessorMetadata
,
error
)
Metadata returns metadata associated with the long-running operation. Metadata itself does not contact the server, but Poll does. To get the latest metadata, call this method after a successful call to Poll. If the metadata is not available, the returned metadata and error are both nil.
func (*DisableProcessorOperation) Name
func
(
op
*
DisableProcessorOperation
)
Name
()
string
Name returns the name of the long-running operation. The name is assigned by the server and is unique within the service from which the operation is created.
func (*DisableProcessorOperation) Poll
func
(
op
*
DisableProcessorOperation
)
Poll
(
ctx
context
.
Context
,
opts
...
gax
.
CallOption
)
(
*
documentaipb
.
DisableProcessorResponse
,
error
)
Poll fetches the latest state of the long-running operation.
Poll also fetches the latest metadata, which can be retrieved by Metadata.
If Poll fails, the error is returned and op is unmodified. If Poll succeeds and the operation has completed with failure, the error is returned and op.Done will return true. If Poll succeeds and the operation has completed successfully, op.Done will return true, and the response of the operation is returned. If Poll succeeds and the operation has not completed, the returned response and error are both nil.
func (*DisableProcessorOperation) Wait
func
(
op
*
DisableProcessorOperation
)
Wait
(
ctx
context
.
Context
,
opts
...
gax
.
CallOption
)
(
*
documentaipb
.
DisableProcessorResponse
,
error
)
Wait blocks until the long-running operation is completed, returning the response and any errors encountered.
See documentation of Poll for error-handling information.
DocumentCallOptions
type
DocumentCallOptions
struct
{
UpdateDataset
[]
gax
.
CallOption
ImportDocuments
[]
gax
.
CallOption
GetDocument
[]
gax
.
CallOption
ListDocuments
[]
gax
.
CallOption
BatchDeleteDocuments
[]
gax
.
CallOption
GetDatasetSchema
[]
gax
.
CallOption
UpdateDatasetSchema
[]
gax
.
CallOption
GetLocation
[]
gax
.
CallOption
ListLocations
[]
gax
.
CallOption
CancelOperation
[]
gax
.
CallOption
GetOperation
[]
gax
.
CallOption
ListOperations
[]
gax
.
CallOption
}
DocumentCallOptions contains the retry settings for each method of DocumentClient.
DocumentClient
type
DocumentClient
struct
{
// The call options for this service.
CallOptions
*
DocumentCallOptions
// LROClient is used internally to handle long-running operations.
// It is exposed so that its CallOptions can be modified if required.
// Users should not Close this client.
LROClient
*
lroauto
.
OperationsClient
// contains filtered or unexported fields
}
DocumentClient is a client for interacting with Cloud Document AI API. Methods, except Close, may be called concurrently. However, fields must not be modified concurrently with method calls.
Service to call Cloud DocumentAI to manage document collection (dataset).
func NewDocumentClient
func
NewDocumentClient
(
ctx
context
.
Context
,
opts
...
option
.
ClientOption
)
(
*
DocumentClient
,
error
)
NewDocumentClient creates a new document service client based on gRPC. The returned client must be Closed when it is done being used to clean up its underlying connections.
Service to call Cloud DocumentAI to manage document collection (dataset).
Example
package
main
import
(
"context"
documentai
"cloud.google.com/go/documentai/apiv1beta3"
)
func
main
()
{
ctx
:=
context
.
Background
()
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating the service client as shown in:
// https://pkg.go.dev/cloud.google.com/go#hdr-Client_Options
c
,
err
:=
documentai
.
NewDocumentClient
(
ctx
)
if
err
!=
nil
{
// TODO: Handle error.
}
defer
c
.
Close
()
// TODO: Use client.
_
=
c
}
func NewDocumentRESTClient
func
NewDocumentRESTClient
(
ctx
context
.
Context
,
opts
...
option
.
ClientOption
)
(
*
DocumentClient
,
error
)
NewDocumentRESTClient creates a new document service rest client.
Service to call Cloud DocumentAI to manage document collection (dataset).
Example
package
main
import
(
"context"
documentai
"cloud.google.com/go/documentai/apiv1beta3"
)
func
main
()
{
ctx
:=
context
.
Background
()
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating the service client as shown in:
// https://pkg.go.dev/cloud.google.com/go#hdr-Client_Options
c
,
err
:=
documentai
.
NewDocumentRESTClient
(
ctx
)
if
err
!=
nil
{
// TODO: Handle error.
}
defer
c
.
Close
()
// TODO: Use client.
_
=
c
}
func (*DocumentClient) BatchDeleteDocuments
func
(
c
*
DocumentClient
)
BatchDeleteDocuments
(
ctx
context
.
Context
,
req
*
documentaipb
.
BatchDeleteDocumentsRequest
,
opts
...
gax
.
CallOption
)
(
*
BatchDeleteDocumentsOperation
,
error
)
BatchDeleteDocuments deletes a set of documents.
Example
package
main
import
(
"context"
documentai
"cloud.google.com/go/documentai/apiv1beta3"
documentaipb
"cloud.google.com/go/documentai/apiv1beta3/documentaipb"
)
func
main
()
{
ctx
:=
context
.
Background
()
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating the service client as shown in:
// https://pkg.go.dev/cloud.google.com/go#hdr-Client_Options
c
,
err
:=
documentai
.
NewDocumentClient
(
ctx
)
if
err
!=
nil
{
// TODO: Handle error.
}
defer
c
.
Close
()
req
:=
& documentaipb
.
BatchDeleteDocumentsRequest
{
// TODO: Fill request struct fields.
// See https://pkg.go.dev/cloud.google.com/go/documentai/apiv1beta3/documentaipb#BatchDeleteDocumentsRequest.
}
op
,
err
:=
c
.
BatchDeleteDocuments
(
ctx
,
req
)
if
err
!=
nil
{
// TODO: Handle error.
}
resp
,
err
:=
op
.
Wait
(
ctx
)
if
err
!=
nil
{
// TODO: Handle error.
}
// TODO: Use resp.
_
=
resp
}
func (*DocumentClient) BatchDeleteDocumentsOperation
func
(
c
*
DocumentClient
)
BatchDeleteDocumentsOperation
(
name
string
)
*
BatchDeleteDocumentsOperation
BatchDeleteDocumentsOperation returns a new BatchDeleteDocumentsOperation from a given name. The name must be that of a previously created BatchDeleteDocumentsOperation, possibly from a different process.
func (*DocumentClient) CancelOperation
func
(
c
*
DocumentClient
)
CancelOperation
(
ctx
context
.
Context
,
req
*
longrunningpb
.
CancelOperationRequest
,
opts
...
gax
.
CallOption
)
error
CancelOperation is a utility method from google.longrunning.Operations.
Example
package
main
import
(
"context"
documentai
"cloud.google.com/go/documentai/apiv1beta3"
longrunningpb
"cloud.google.com/go/longrunning/autogen/longrunningpb"
)
func
main
()
{
ctx
:=
context
.
Background
()
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating the service client as shown in:
// https://pkg.go.dev/cloud.google.com/go#hdr-Client_Options
c
,
err
:=
documentai
.
NewDocumentClient
(
ctx
)
if
err
!=
nil
{
// TODO: Handle error.
}
defer
c
.
Close
()
req
:=
& longrunningpb
.
CancelOperationRequest
{
// TODO: Fill request struct fields.
// See https://pkg.go.dev/cloud.google.com/go/longrunning/autogen/longrunningpb#CancelOperationRequest.
}
err
=
c
.
CancelOperation
(
ctx
,
req
)
if
err
!=
nil
{
// TODO: Handle error.
}
}
func (*DocumentClient) Close
func
(
c
*
DocumentClient
)
Close
()
error
Close closes the connection to the API service. The user should invoke this when the client is no longer required.
func (*DocumentClient) Connection (deprecated)
func
(
c
*
DocumentClient
)
Connection
()
*
grpc
.
ClientConn
Connection returns a connection to the API service.
Deprecated: Connections are now pooled so this method does not always return the same resource.
func (*DocumentClient) GetDatasetSchema
func
(
c
*
DocumentClient
)
GetDatasetSchema
(
ctx
context
.
Context
,
req
*
documentaipb
.
GetDatasetSchemaRequest
,
opts
...
gax
.
CallOption
)
(
*
documentaipb
.
DatasetSchema
,
error
)
GetDatasetSchema gets the DatasetSchema of a Dataset.
Example
package
main
import
(
"context"
documentai
"cloud.google.com/go/documentai/apiv1beta3"
documentaipb
"cloud.google.com/go/documentai/apiv1beta3/documentaipb"
)
func
main
()
{
ctx
:=
context
.
Background
()
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating the service client as shown in:
// https://pkg.go.dev/cloud.google.com/go#hdr-Client_Options
c
,
err
:=
documentai
.
NewDocumentClient
(
ctx
)
if
err
!=
nil
{
// TODO: Handle error.
}
defer
c
.
Close
()
req
:=
& documentaipb
.
GetDatasetSchemaRequest
{
// TODO: Fill request struct fields.
// See https://pkg.go.dev/cloud.google.com/go/documentai/apiv1beta3/documentaipb#GetDatasetSchemaRequest.
}
resp
,
err
:=
c
.
GetDatasetSchema
(
ctx
,
req
)
if
err
!=
nil
{
// TODO: Handle error.
}
// TODO: Use resp.
_
=
resp
}
func (*DocumentClient) GetDocument
func
(
c
*
DocumentClient
)
GetDocument
(
ctx
context
.
Context
,
req
*
documentaipb
.
GetDocumentRequest
,
opts
...
gax
.
CallOption
)
(
*
documentaipb
.
GetDocumentResponse
,
error
)
GetDocument returns relevant fields present in the requested document.
Example
package
main
import
(
"context"
documentai
"cloud.google.com/go/documentai/apiv1beta3"
documentaipb
"cloud.google.com/go/documentai/apiv1beta3/documentaipb"
)
func
main
()
{
ctx
:=
context
.
Background
()
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating the service client as shown in:
// https://pkg.go.dev/cloud.google.com/go#hdr-Client_Options
c
,
err
:=
documentai
.
NewDocumentClient
(
ctx
)
if
err
!=
nil
{
// TODO: Handle error.
}
defer
c
.
Close
()
req
:=
& documentaipb
.
GetDocumentRequest
{
// TODO: Fill request struct fields.
// See https://pkg.go.dev/cloud.google.com/go/documentai/apiv1beta3/documentaipb#GetDocumentRequest.
}
resp
,
err
:=
c
.
GetDocument
(
ctx
,
req
)
if
err
!=
nil
{
// TODO: Handle error.
}
// TODO: Use resp.
_
=
resp
}
func (*DocumentClient) GetLocation
func
(
c
*
DocumentClient
)
GetLocation
(
ctx
context
.
Context
,
req
*
locationpb
.
GetLocationRequest
,
opts
...
gax
.
CallOption
)
(
*
locationpb
.
Location
,
error
)
GetLocation gets information about a location.
Example
package
main
import
(
"context"
documentai
"cloud.google.com/go/documentai/apiv1beta3"
locationpb
"google.golang.org/genproto/googleapis/cloud/location"
)
func
main
()
{
ctx
:=
context
.
Background
()
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating the service client as shown in:
// https://pkg.go.dev/cloud.google.com/go#hdr-Client_Options
c
,
err
:=
documentai
.
NewDocumentClient
(
ctx
)
if
err
!=
nil
{
// TODO: Handle error.
}
defer
c
.
Close
()
req
:=
& locationpb
.
GetLocationRequest
{
// TODO: Fill request struct fields.
// See https://pkg.go.dev/google.golang.org/genproto/googleapis/cloud/location#GetLocationRequest.
}
resp
,
err
:=
c
.
GetLocation
(
ctx
,
req
)
if
err
!=
nil
{
// TODO: Handle error.
}
// TODO: Use resp.
_
=
resp
}
func (*DocumentClient) GetOperation
func
(
c
*
DocumentClient
)
GetOperation
(
ctx
context
.
Context
,
req
*
longrunningpb
.
GetOperationRequest
,
opts
...
gax
.
CallOption
)
(
*
longrunningpb
.
Operation
,
error
)
GetOperation is a utility method from google.longrunning.Operations.
Example
package
main
import
(
"context"
documentai
"cloud.google.com/go/documentai/apiv1beta3"
longrunningpb
"cloud.google.com/go/longrunning/autogen/longrunningpb"
)
func
main
()
{
ctx
:=
context
.
Background
()
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating the service client as shown in:
// https://pkg.go.dev/cloud.google.com/go#hdr-Client_Options
c
,
err
:=
documentai
.
NewDocumentClient
(
ctx
)
if
err
!=
nil
{
// TODO: Handle error.
}
defer
c
.
Close
()
req
:=
& longrunningpb
.
GetOperationRequest
{
// TODO: Fill request struct fields.
// See https://pkg.go.dev/cloud.google.com/go/longrunning/autogen/longrunningpb#GetOperationRequest.
}
resp
,
err
:=
c
.
GetOperation
(
ctx
,
req
)
if
err
!=
nil
{
// TODO: Handle error.
}
// TODO: Use resp.
_
=
resp
}
func (*DocumentClient) ImportDocuments
func
(
c
*
DocumentClient
)
ImportDocuments
(
ctx
context
.
Context
,
req
*
documentaipb
.
ImportDocumentsRequest
,
opts
...
gax
.
CallOption
)
(
*
ImportDocumentsOperation
,
error
)
ImportDocuments import documents into a dataset.
Example
package
main
import
(
"context"
documentai
"cloud.google.com/go/documentai/apiv1beta3"
documentaipb
"cloud.google.com/go/documentai/apiv1beta3/documentaipb"
)
func
main
()
{
ctx
:=
context
.
Background
()
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating the service client as shown in:
// https://pkg.go.dev/cloud.google.com/go#hdr-Client_Options
c
,
err
:=
documentai
.
NewDocumentClient
(
ctx
)
if
err
!=
nil
{
// TODO: Handle error.
}
defer
c
.
Close
()
req
:=
& documentaipb
.
ImportDocumentsRequest
{
// TODO: Fill request struct fields.
// See https://pkg.go.dev/cloud.google.com/go/documentai/apiv1beta3/documentaipb#ImportDocumentsRequest.
}
op
,
err
:=
c
.
ImportDocuments
(
ctx
,
req
)
if
err
!=
nil
{
// TODO: Handle error.
}
resp
,
err
:=
op
.
Wait
(
ctx
)
if
err
!=
nil
{
// TODO: Handle error.
}
// TODO: Use resp.
_
=
resp
}
func (*DocumentClient) ImportDocumentsOperation
func
(
c
*
DocumentClient
)
ImportDocumentsOperation
(
name
string
)
*
ImportDocumentsOperation
ImportDocumentsOperation returns a new ImportDocumentsOperation from a given name. The name must be that of a previously created ImportDocumentsOperation, possibly from a different process.
func (*DocumentClient) ListDocuments
func
(
c
*
DocumentClient
)
ListDocuments
(
ctx
context
.
Context
,
req
*
documentaipb
.
ListDocumentsRequest
,
opts
...
gax
.
CallOption
)
*
DocumentMetadataIterator
ListDocuments returns a list of documents present in the dataset.
Example
package
main
import
(
"context"
documentai
"cloud.google.com/go/documentai/apiv1beta3"
documentaipb
"cloud.google.com/go/documentai/apiv1beta3/documentaipb"
"google.golang.org/api/iterator"
)
func
main
()
{
ctx
:=
context
.
Background
()
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating the service client as shown in:
// https://pkg.go.dev/cloud.google.com/go#hdr-Client_Options
c
,
err
:=
documentai
.
NewDocumentClient
(
ctx
)
if
err
!=
nil
{
// TODO: Handle error.
}
defer
c
.
Close
()
req
:=
& documentaipb
.
ListDocumentsRequest
{
// TODO: Fill request struct fields.
// See https://pkg.go.dev/cloud.google.com/go/documentai/apiv1beta3/documentaipb#ListDocumentsRequest.
}
it
:=
c
.
ListDocuments
(
ctx
,
req
)
for
{
resp
,
err
:=
it
.
Next
()
if
err
==
iterator
.
Done
{
break
}
if
err
!=
nil
{
// TODO: Handle error.
}
// TODO: Use resp.
_
=
resp
// If you need to access the underlying RPC response,
// you can do so by casting the `Response` as below.
// Otherwise, remove this line. Only populated after
// first call to Next(). Not safe for concurrent access.
_
=
it
.
Response
.(
*
documentaipb
.
ListDocumentsResponse
)
}
}
func (*DocumentClient) ListLocations
func
(
c
*
DocumentClient
)
ListLocations
(
ctx
context
.
Context
,
req
*
locationpb
.
ListLocationsRequest
,
opts
...
gax
.
CallOption
)
*
LocationIterator
ListLocations lists information about the supported locations for this service.
Example
package
main
import
(
"context"
documentai
"cloud.google.com/go/documentai/apiv1beta3"
"google.golang.org/api/iterator"
locationpb
"google.golang.org/genproto/googleapis/cloud/location"
)
func
main
()
{
ctx
:=
context
.
Background
()
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating the service client as shown in:
// https://pkg.go.dev/cloud.google.com/go#hdr-Client_Options
c
,
err
:=
documentai
.
NewDocumentClient
(
ctx
)
if
err
!=
nil
{
// TODO: Handle error.
}
defer
c
.
Close
()
req
:=
& locationpb
.
ListLocationsRequest
{
// TODO: Fill request struct fields.
// See https://pkg.go.dev/google.golang.org/genproto/googleapis/cloud/location#ListLocationsRequest.
}
it
:=
c
.
ListLocations
(
ctx
,
req
)
for
{
resp
,
err
:=
it
.
Next
()
if
err
==
iterator
.
Done
{
break
}
if
err
!=
nil
{
// TODO: Handle error.
}
// TODO: Use resp.
_
=
resp
// If you need to access the underlying RPC response,
// you can do so by casting the `Response` as below.
// Otherwise, remove this line. Only populated after
// first call to Next(). Not safe for concurrent access.
_
=
it
.
Response
.(
*
locationpb
.
ListLocationsResponse
)
}
}
func (*DocumentClient) ListOperations
func
(
c
*
DocumentClient
)
ListOperations
(
ctx
context
.
Context
,
req
*
longrunningpb
.
ListOperationsRequest
,
opts
...
gax
.
CallOption
)
*
OperationIterator
ListOperations is a utility method from google.longrunning.Operations.
Example
package
main
import
(
"context"
documentai
"cloud.google.com/go/documentai/apiv1beta3"
longrunningpb
"cloud.google.com/go/longrunning/autogen/longrunningpb"
"google.golang.org/api/iterator"
)
func
main
()
{
ctx
:=
context
.
Background
()
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating the service client as shown in:
// https://pkg.go.dev/cloud.google.com/go#hdr-Client_Options
c
,
err
:=
documentai
.
NewDocumentClient
(
ctx
)
if
err
!=
nil
{
// TODO: Handle error.
}
defer
c
.
Close
()
req
:=
& longrunningpb
.
ListOperationsRequest
{
// TODO: Fill request struct fields.
// See https://pkg.go.dev/cloud.google.com/go/longrunning/autogen/longrunningpb#ListOperationsRequest.
}
it
:=
c
.
ListOperations
(
ctx
,
req
)
for
{
resp
,
err
:=
it
.
Next
()
if
err
==
iterator
.
Done
{
break
}
if
err
!=
nil
{
// TODO: Handle error.
}
// TODO: Use resp.
_
=
resp
// If you need to access the underlying RPC response,
// you can do so by casting the `Response` as below.
// Otherwise, remove this line. Only populated after
// first call to Next(). Not safe for concurrent access.
_
=
it
.
Response
.(
*
longrunningpb
.
ListOperationsResponse
)
}
}
func (*DocumentClient) UpdateDataset
func
(
c
*
DocumentClient
)
UpdateDataset
(
ctx
context
.
Context
,
req
*
documentaipb
.
UpdateDatasetRequest
,
opts
...
gax
.
CallOption
)
(
*
UpdateDatasetOperation
,
error
)
UpdateDataset updates metadata associated with a dataset.
Example
package
main
import
(
"context"
documentai
"cloud.google.com/go/documentai/apiv1beta3"
documentaipb
"cloud.google.com/go/documentai/apiv1beta3/documentaipb"
)
func
main
()
{
ctx
:=
context
.
Background
()
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating the service client as shown in:
// https://pkg.go.dev/cloud.google.com/go#hdr-Client_Options
c
,
err
:=
documentai
.
NewDocumentClient
(
ctx
)
if
err
!=
nil
{
// TODO: Handle error.
}
defer
c
.
Close
()
req
:=
& documentaipb
.
UpdateDatasetRequest
{
// TODO: Fill request struct fields.
// See https://pkg.go.dev/cloud.google.com/go/documentai/apiv1beta3/documentaipb#UpdateDatasetRequest.
}
op
,
err
:=
c
.
UpdateDataset
(
ctx
,
req
)
if
err
!=
nil
{
// TODO: Handle error.
}
resp
,
err
:=
op
.
Wait
(
ctx
)
if
err
!=
nil
{
// TODO: Handle error.
}
// TODO: Use resp.
_
=
resp
}
func (*DocumentClient) UpdateDatasetOperation
func
(
c
*
DocumentClient
)
UpdateDatasetOperation
(
name
string
)
*
UpdateDatasetOperation
UpdateDatasetOperation returns a new UpdateDatasetOperation from a given name. The name must be that of a previously created UpdateDatasetOperation, possibly from a different process.
func (*DocumentClient) UpdateDatasetSchema
func
(
c
*
DocumentClient
)
UpdateDatasetSchema
(
ctx
context
.
Context
,
req
*
documentaipb
.
UpdateDatasetSchemaRequest
,
opts
...
gax
.
CallOption
)
(
*
documentaipb
.
DatasetSchema
,
error
)
UpdateDatasetSchema updates a DatasetSchema.
Example
package
main
import
(
"context"
documentai
"cloud.google.com/go/documentai/apiv1beta3"
documentaipb
"cloud.google.com/go/documentai/apiv1beta3/documentaipb"
)
func
main
()
{
ctx
:=
context
.
Background
()
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating the service client as shown in:
// https://pkg.go.dev/cloud.google.com/go#hdr-Client_Options
c
,
err
:=
documentai
.
NewDocumentClient
(
ctx
)
if
err
!=
nil
{
// TODO: Handle error.
}
defer
c
.
Close
()
req
:=
& documentaipb
.
UpdateDatasetSchemaRequest
{
// TODO: Fill request struct fields.
// See https://pkg.go.dev/cloud.google.com/go/documentai/apiv1beta3/documentaipb#UpdateDatasetSchemaRequest.
}
resp
,
err
:=
c
.
UpdateDatasetSchema
(
ctx
,
req
)
if
err
!=
nil
{
// TODO: Handle error.
}
// TODO: Use resp.
_
=
resp
}
DocumentMetadataIterator
type
DocumentMetadataIterator
struct
{
// Response is the raw response for the current page.
// It must be cast to the RPC response type.
// Calling Next() or InternalFetch() updates this value.
Response
interface
{}
// InternalFetch is for use by the Google Cloud Libraries only.
// It is not part of the stable interface of this package.
//
// InternalFetch returns results from a single call to the underlying RPC.
// The number of results is no greater than pageSize.
// If there are no more results, nextPageToken is empty and err is nil.
InternalFetch
func
(
pageSize
int
,
pageToken
string
)
(
results
[]
*
documentaipb
.
DocumentMetadata
,
nextPageToken
string
,
err
error
)
// contains filtered or unexported fields
}
DocumentMetadataIterator manages a stream of *documentaipb.DocumentMetadata.
func (*DocumentMetadataIterator) Next
func
(
it
*
DocumentMetadataIterator
)
Next
()
(
*
documentaipb
.
DocumentMetadata
,
error
)
Next returns the next result. Its second return value is iterator.Done if there are no more results. Once Next returns Done, all subsequent calls will return Done.
func (*DocumentMetadataIterator) PageInfo
func
(
it
*
DocumentMetadataIterator
)
PageInfo
()
*
iterator
.
PageInfo
PageInfo supports pagination. See the google.golang.org/api/iterator package for details.
DocumentProcessorCallOptions
type
DocumentProcessorCallOptions
struct
{
ProcessDocument
[]
gax
.
CallOption
BatchProcessDocuments
[]
gax
.
CallOption
FetchProcessorTypes
[]
gax
.
CallOption
ListProcessorTypes
[]
gax
.
CallOption
GetProcessorType
[]
gax
.
CallOption
ListProcessors
[]
gax
.
CallOption
GetProcessor
[]
gax
.
CallOption
TrainProcessorVersion
[]
gax
.
CallOption
GetProcessorVersion
[]
gax
.
CallOption
ListProcessorVersions
[]
gax
.
CallOption
DeleteProcessorVersion
[]
gax
.
CallOption
DeployProcessorVersion
[]
gax
.
CallOption
UndeployProcessorVersion
[]
gax
.
CallOption
CreateProcessor
[]
gax
.
CallOption
DeleteProcessor
[]
gax
.
CallOption
EnableProcessor
[]
gax
.
CallOption
DisableProcessor
[]
gax
.
CallOption
SetDefaultProcessorVersion
[]
gax
.
CallOption
ReviewDocument
[]
gax
.
CallOption
EvaluateProcessorVersion
[]
gax
.
CallOption
GetEvaluation
[]
gax
.
CallOption
ListEvaluations
[]
gax
.
CallOption
ImportProcessorVersion
[]
gax
.
CallOption
GetLocation
[]
gax
.
CallOption
ListLocations
[]
gax
.
CallOption
CancelOperation
[]
gax
.
CallOption
GetOperation
[]
gax
.
CallOption
ListOperations
[]
gax
.
CallOption
}
DocumentProcessorCallOptions contains the retry settings for each method of DocumentProcessorClient.
DocumentProcessorClient
type
DocumentProcessorClient
struct
{
// The call options for this service.
CallOptions
*
DocumentProcessorCallOptions
// LROClient is used internally to handle long-running operations.
// It is exposed so that its CallOptions can be modified if required.
// Users should not Close this client.
LROClient
*
lroauto
.
OperationsClient
// contains filtered or unexported fields
}
DocumentProcessorClient is a client for interacting with Cloud Document AI API. Methods, except Close, may be called concurrently. However, fields must not be modified concurrently with method calls.
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.
func NewDocumentProcessorClient
func
NewDocumentProcessorClient
(
ctx
context
.
Context
,
opts
...
option
.
ClientOption
)
(
*
DocumentProcessorClient
,
error
)
NewDocumentProcessorClient creates a new document processor service client based on gRPC. The returned client must be Closed when it is done being used to clean up its underlying connections.
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.
Example
package
main
import
(
"context"
documentai
"cloud.google.com/go/documentai/apiv1beta3"
)
func
main
()
{
ctx
:=
context
.
Background
()
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating the service client as shown in:
// https://pkg.go.dev/cloud.google.com/go#hdr-Client_Options
c
,
err
:=
documentai
.
NewDocumentProcessorClient
(
ctx
)
if
err
!=
nil
{
// TODO: Handle error.
}
defer
c
.
Close
()
// TODO: Use client.
_
=
c
}
func NewDocumentProcessorRESTClient
func
NewDocumentProcessorRESTClient
(
ctx
context
.
Context
,
opts
...
option
.
ClientOption
)
(
*
DocumentProcessorClient
,
error
)
NewDocumentProcessorRESTClient creates a new document processor service rest client.
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.
Example
package
main
import
(
"context"
documentai
"cloud.google.com/go/documentai/apiv1beta3"
)
func
main
()
{
ctx
:=
context
.
Background
()
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating the service client as shown in:
// https://pkg.go.dev/cloud.google.com/go#hdr-Client_Options
c
,
err
:=
documentai
.
NewDocumentProcessorRESTClient
(
ctx
)
if
err
!=
nil
{
// TODO: Handle error.
}
defer
c
.
Close
()
// TODO: Use client.
_
=
c
}
func (*DocumentProcessorClient) BatchProcessDocuments
func
(
c
*
DocumentProcessorClient
)
BatchProcessDocuments
(
ctx
context
.
Context
,
req
*
documentaipb
.
BatchProcessRequest
,
opts
...
gax
.
CallOption
)
(
*
BatchProcessDocumentsOperation
,
error
)
BatchProcessDocuments lRO endpoint to batch process many documents. The output is written to Cloud Storage as JSON in the [Document] format.
Example
package
main
import
(
"context"
documentai
"cloud.google.com/go/documentai/apiv1beta3"
documentaipb
"cloud.google.com/go/documentai/apiv1beta3/documentaipb"
)
func
main
()
{
ctx
:=
context
.
Background
()
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating the service client as shown in:
// https://pkg.go.dev/cloud.google.com/go#hdr-Client_Options
c
,
err
:=
documentai
.
NewDocumentProcessorClient
(
ctx
)
if
err
!=
nil
{
// TODO: Handle error.
}
defer
c
.
Close
()
req
:=
& documentaipb
.
BatchProcessRequest
{
// TODO: Fill request struct fields.
// See https://pkg.go.dev/cloud.google.com/go/documentai/apiv1beta3/documentaipb#BatchProcessRequest.
}
op
,
err
:=
c
.
BatchProcessDocuments
(
ctx
,
req
)
if
err
!=
nil
{
// TODO: Handle error.
}
resp
,
err
:=
op
.
Wait
(
ctx
)
if
err
!=
nil
{
// TODO: Handle error.
}
// TODO: Use resp.
_
=
resp
}
func (*DocumentProcessorClient) BatchProcessDocumentsOperation
func
(
c
*
DocumentProcessorClient
)
BatchProcessDocumentsOperation
(
name
string
)
*
BatchProcessDocumentsOperation
BatchProcessDocumentsOperation returns a new BatchProcessDocumentsOperation from a given name. The name must be that of a previously created BatchProcessDocumentsOperation, possibly from a different process.
func (*DocumentProcessorClient) CancelOperation
func
(
c
*
DocumentProcessorClient
)
CancelOperation
(
ctx
context
.
Context
,
req
*
longrunningpb
.
CancelOperationRequest
,
opts
...
gax
.
CallOption
)
error
CancelOperation is a utility method from google.longrunning.Operations.
Example
package
main
import
(
"context"
documentai
"cloud.google.com/go/documentai/apiv1beta3"
longrunningpb
"cloud.google.com/go/longrunning/autogen/longrunningpb"
)
func
main
()
{
ctx
:=
context
.
Background
()
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating the service client as shown in:
// https://pkg.go.dev/cloud.google.com/go#hdr-Client_Options
c
,
err
:=
documentai
.
NewDocumentProcessorClient
(
ctx
)
if
err
!=
nil
{
// TODO: Handle error.
}
defer
c
.
Close
()
req
:=
& longrunningpb
.
CancelOperationRequest
{
// TODO: Fill request struct fields.
// See https://pkg.go.dev/cloud.google.com/go/longrunning/autogen/longrunningpb#CancelOperationRequest.
}
err
=
c
.
CancelOperation
(
ctx
,
req
)
if
err
!=
nil
{
// TODO: Handle error.
}
}
func (*DocumentProcessorClient) Close
func
(
c
*
DocumentProcessorClient
)
Close
()
error
Close closes the connection to the API service. The user should invoke this when the client is no longer required.
func (*DocumentProcessorClient) Connection (deprecated)
func
(
c
*
DocumentProcessorClient
)
Connection
()
*
grpc
.
ClientConn
Connection returns a connection to the API service.
Deprecated: Connections are now pooled so this method does not always return the same resource.
func (*DocumentProcessorClient) CreateProcessor
func
(
c
*
DocumentProcessorClient
)
CreateProcessor
(
ctx
context
.
Context
,
req
*
documentaipb
.
CreateProcessorRequest
,
opts
...
gax
.
CallOption
)
(
*
documentaipb
.
Processor
,
error
)
CreateProcessor creates a processor from the ProcessorType provided. The processor will be at ENABLED state by default after its creation.
Example
package
main
import
(
"context"
documentai
"cloud.google.com/go/documentai/apiv1beta3"
documentaipb
"cloud.google.com/go/documentai/apiv1beta3/documentaipb"
)
func
main
()
{
ctx
:=
context
.
Background
()
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating the service client as shown in:
// https://pkg.go.dev/cloud.google.com/go#hdr-Client_Options
c
,
err
:=
documentai
.
NewDocumentProcessorClient
(
ctx
)
if
err
!=
nil
{
// TODO: Handle error.
}
defer
c
.
Close
()
req
:=
& documentaipb
.
CreateProcessorRequest
{
// TODO: Fill request struct fields.
// See https://pkg.go.dev/cloud.google.com/go/documentai/apiv1beta3/documentaipb#CreateProcessorRequest.
}
resp
,
err
:=
c
.
CreateProcessor
(
ctx
,
req
)
if
err
!=
nil
{
// TODO: Handle error.
}
// TODO: Use resp.
_
=
resp
}
func (*DocumentProcessorClient) DeleteProcessor
func
(
c
*
DocumentProcessorClient
)
DeleteProcessor
(
ctx
context
.
Context
,
req
*
documentaipb
.
DeleteProcessorRequest
,
opts
...
gax
.
CallOption
)
(
*
DeleteProcessorOperation
,
error
)
DeleteProcessor deletes the processor, unloads all deployed model artifacts if it was enabled and then deletes all artifacts associated with this processor.
Example
package
main
import
(
"context"
documentai
"cloud.google.com/go/documentai/apiv1beta3"
documentaipb
"cloud.google.com/go/documentai/apiv1beta3/documentaipb"
)
func
main
()
{
ctx
:=
context
.
Background
()
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating the service client as shown in:
// https://pkg.go.dev/cloud.google.com/go#hdr-Client_Options
c
,
err
:=
documentai
.
NewDocumentProcessorClient
(
ctx
)
if
err
!=
nil
{
// TODO: Handle error.
}
defer
c
.
Close
()
req
:=
& documentaipb
.
DeleteProcessorRequest
{
// TODO: Fill request struct fields.
// See https://pkg.go.dev/cloud.google.com/go/documentai/apiv1beta3/documentaipb#DeleteProcessorRequest.
}
op
,
err
:=
c
.
DeleteProcessor
(
ctx
,
req
)
if
err
!=
nil
{
// TODO: Handle error.
}
err
=
op
.
Wait
(
ctx
)
if
err
!=
nil
{
// TODO: Handle error.
}
}
func (*DocumentProcessorClient) DeleteProcessorOperation
func
(
c
*
DocumentProcessorClient
)
DeleteProcessorOperation
(
name
string
)
*
DeleteProcessorOperation
DeleteProcessorOperation returns a new DeleteProcessorOperation from a given name. The name must be that of a previously created DeleteProcessorOperation, possibly from a different process.
func (*DocumentProcessorClient) DeleteProcessorVersion
func
(
c
*
DocumentProcessorClient
)
DeleteProcessorVersion
(
ctx
context
.
Context
,
req
*
documentaipb
.
DeleteProcessorVersionRequest
,
opts
...
gax
.
CallOption
)
(
*
DeleteProcessorVersionOperation
,
error
)
DeleteProcessorVersion deletes the processor version, all artifacts under the processor version will be deleted.
Example
package
main
import
(
"context"
documentai
"cloud.google.com/go/documentai/apiv1beta3"
documentaipb
"cloud.google.com/go/documentai/apiv1beta3/documentaipb"
)
func
main
()
{
ctx
:=
context
.
Background
()
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating the service client as shown in:
// https://pkg.go.dev/cloud.google.com/go#hdr-Client_Options
c
,
err
:=
documentai
.
NewDocumentProcessorClient
(
ctx
)
if
err
!=
nil
{
// TODO: Handle error.
}
defer
c
.
Close
()
req
:=
& documentaipb
.
DeleteProcessorVersionRequest
{
// TODO: Fill request struct fields.
// See https://pkg.go.dev/cloud.google.com/go/documentai/apiv1beta3/documentaipb#DeleteProcessorVersionRequest.
}
op
,
err
:=
c
.
DeleteProcessorVersion
(
ctx
,
req
)
if
err
!=
nil
{
// TODO: Handle error.
}
err
=
op
.
Wait
(
ctx
)
if
err
!=
nil
{
// TODO: Handle error.
}
}
func (*DocumentProcessorClient) DeleteProcessorVersionOperation
func
(
c
*
DocumentProcessorClient
)
DeleteProcessorVersionOperation
(
name
string
)
*
DeleteProcessorVersionOperation
DeleteProcessorVersionOperation returns a new DeleteProcessorVersionOperation from a given name. The name must be that of a previously created DeleteProcessorVersionOperation, possibly from a different process.
func (*DocumentProcessorClient) DeployProcessorVersion
func
(
c
*
DocumentProcessorClient
)
DeployProcessorVersion
(
ctx
context
.
Context
,
req
*
documentaipb
.
DeployProcessorVersionRequest
,
opts
...
gax
.
CallOption
)
(
*
DeployProcessorVersionOperation
,
error
)
DeployProcessorVersion deploys the processor version.
Example
package
main
import
(
"context"
documentai
"cloud.google.com/go/documentai/apiv1beta3"
documentaipb
"cloud.google.com/go/documentai/apiv1beta3/documentaipb"
)
func
main
()
{
ctx
:=
context
.
Background
()
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating the service client as shown in:
// https://pkg.go.dev/cloud.google.com/go#hdr-Client_Options
c
,
err
:=
documentai
.
NewDocumentProcessorClient
(
ctx
)
if
err
!=
nil
{
// TODO: Handle error.
}
defer
c
.
Close
()
req
:=
& documentaipb
.
DeployProcessorVersionRequest
{
// TODO: Fill request struct fields.
// See https://pkg.go.dev/cloud.google.com/go/documentai/apiv1beta3/documentaipb#DeployProcessorVersionRequest.
}
op
,
err
:=
c
.
DeployProcessorVersion
(
ctx
,
req
)
if
err
!=
nil
{
// TODO: Handle error.
}
resp
,
err
:=
op
.
Wait
(
ctx
)
if
err
!=
nil
{
// TODO: Handle error.
}
// TODO: Use resp.
_
=
resp
}
func (*DocumentProcessorClient) DeployProcessorVersionOperation
func
(
c
*
DocumentProcessorClient
)
DeployProcessorVersionOperation
(
name
string
)
*
DeployProcessorVersionOperation
DeployProcessorVersionOperation returns a new DeployProcessorVersionOperation from a given name. The name must be that of a previously created DeployProcessorVersionOperation, possibly from a different process.
func (*DocumentProcessorClient) DisableProcessor
func
(
c
*
DocumentProcessorClient
)
DisableProcessor
(
ctx
context
.
Context
,
req
*
documentaipb
.
DisableProcessorRequest
,
opts
...
gax
.
CallOption
)
(
*
DisableProcessorOperation
,
error
)
DisableProcessor disables a processor
Example
package
main
import
(
"context"
documentai
"cloud.google.com/go/documentai/apiv1beta3"
documentaipb
"cloud.google.com/go/documentai/apiv1beta3/documentaipb"
)
func
main
()
{
ctx
:=
context
.
Background
()
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating the service client as shown in:
// https://pkg.go.dev/cloud.google.com/go#hdr-Client_Options
c
,
err
:=
documentai
.
NewDocumentProcessorClient
(
ctx
)
if
err
!=
nil
{
// TODO: Handle error.
}
defer
c
.
Close
()
req
:=
& documentaipb
.
DisableProcessorRequest
{
// TODO: Fill request struct fields.
// See https://pkg.go.dev/cloud.google.com/go/documentai/apiv1beta3/documentaipb#DisableProcessorRequest.
}
op
,
err
:=
c
.
DisableProcessor
(
ctx
,
req
)
if
err
!=
nil
{
// TODO: Handle error.
}
resp
,
err
:=
op
.
Wait
(
ctx
)
if
err
!=
nil
{
// TODO: Handle error.
}
// TODO: Use resp.
_
=
resp
}
func (*DocumentProcessorClient) DisableProcessorOperation
func
(
c
*
DocumentProcessorClient
)
DisableProcessorOperation
(
name
string
)
*
DisableProcessorOperation
DisableProcessorOperation returns a new DisableProcessorOperation from a given name. The name must be that of a previously created DisableProcessorOperation, possibly from a different process.
func (*DocumentProcessorClient) EnableProcessor
func
(
c
*
DocumentProcessorClient
)
EnableProcessor
(
ctx
context
.
Context
,
req
*
documentaipb
.
EnableProcessorRequest
,
opts
...
gax
.
CallOption
)
(
*
EnableProcessorOperation
,
error
)
EnableProcessor enables a processor
Example
package
main
import
(
"context"
documentai
"cloud.google.com/go/documentai/apiv1beta3"
documentaipb
"cloud.google.com/go/documentai/apiv1beta3/documentaipb"
)
func
main
()
{
ctx
:=
context
.
Background
()
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating the service client as shown in:
// https://pkg.go.dev/cloud.google.com/go#hdr-Client_Options
c
,
err
:=
documentai
.
NewDocumentProcessorClient
(
ctx
)
if
err
!=
nil
{
// TODO: Handle error.
}
defer
c
.
Close
()
req
:=
& documentaipb
.
EnableProcessorRequest
{
// TODO: Fill request struct fields.
// See https://pkg.go.dev/cloud.google.com/go/documentai/apiv1beta3/documentaipb#EnableProcessorRequest.
}
op
,
err
:=
c
.
EnableProcessor
(
ctx
,
req
)
if
err
!=
nil
{
// TODO: Handle error.
}
resp
,
err
:=
op
.
Wait
(
ctx
)
if
err
!=
nil
{
// TODO: Handle error.
}
// TODO: Use resp.
_
=
resp
}
func (*DocumentProcessorClient) EnableProcessorOperation
func
(
c
*
DocumentProcessorClient
)
EnableProcessorOperation
(
name
string
)
*
EnableProcessorOperation
EnableProcessorOperation returns a new EnableProcessorOperation from a given name. The name must be that of a previously created EnableProcessorOperation, possibly from a different process.
func (*DocumentProcessorClient) EvaluateProcessorVersion
func
(
c
*
DocumentProcessorClient
)
EvaluateProcessorVersion
(
ctx
context
.
Context
,
req
*
documentaipb
.
EvaluateProcessorVersionRequest
,
opts
...
gax
.
CallOption
)
(
*
EvaluateProcessorVersionOperation
,
error
)
EvaluateProcessorVersion evaluates a ProcessorVersion against annotated documents, producing an Evaluation.
Example
package
main
import
(
"context"
documentai
"cloud.google.com/go/documentai/apiv1beta3"
documentaipb
"cloud.google.com/go/documentai/apiv1beta3/documentaipb"
)
func
main
()
{
ctx
:=
context
.
Background
()
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating the service client as shown in:
// https://pkg.go.dev/cloud.google.com/go#hdr-Client_Options
c
,
err
:=
documentai
.
NewDocumentProcessorClient
(
ctx
)
if
err
!=
nil
{
// TODO: Handle error.
}
defer
c
.
Close
()
req
:=
& documentaipb
.
EvaluateProcessorVersionRequest
{
// TODO: Fill request struct fields.
// See https://pkg.go.dev/cloud.google.com/go/documentai/apiv1beta3/documentaipb#EvaluateProcessorVersionRequest.
}
op
,
err
:=
c
.
EvaluateProcessorVersion
(
ctx
,
req
)
if
err
!=
nil
{
// TODO: Handle error.
}
resp
,
err
:=
op
.
Wait
(
ctx
)
if
err
!=
nil
{
// TODO: Handle error.
}
// TODO: Use resp.
_
=
resp
}
func (*DocumentProcessorClient) EvaluateProcessorVersionOperation
func
(
c
*
DocumentProcessorClient
)
EvaluateProcessorVersionOperation
(
name
string
)
*
EvaluateProcessorVersionOperation
EvaluateProcessorVersionOperation returns a new EvaluateProcessorVersionOperation from a given name. The name must be that of a previously created EvaluateProcessorVersionOperation, possibly from a different process.
func (*DocumentProcessorClient) FetchProcessorTypes
func
(
c
*
DocumentProcessorClient
)
FetchProcessorTypes
(
ctx
context
.
Context
,
req
*
documentaipb
.
FetchProcessorTypesRequest
,
opts
...
gax
.
CallOption
)
(
*
documentaipb
.
FetchProcessorTypesResponse
,
error
)
FetchProcessorTypes fetches processor types. Note that we don’t use ListProcessorTypes here, because it isn’t paginated.
Example
package
main
import
(
"context"
documentai
"cloud.google.com/go/documentai/apiv1beta3"
documentaipb
"cloud.google.com/go/documentai/apiv1beta3/documentaipb"
)
func
main
()
{
ctx
:=
context
.
Background
()
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating the service client as shown in:
// https://pkg.go.dev/cloud.google.com/go#hdr-Client_Options
c
,
err
:=
documentai
.
NewDocumentProcessorClient
(
ctx
)
if
err
!=
nil
{
// TODO: Handle error.
}
defer
c
.
Close
()
req
:=
& documentaipb
.
FetchProcessorTypesRequest
{
// TODO: Fill request struct fields.
// See https://pkg.go.dev/cloud.google.com/go/documentai/apiv1beta3/documentaipb#FetchProcessorTypesRequest.
}
resp
,
err
:=
c
.
FetchProcessorTypes
(
ctx
,
req
)
if
err
!=
nil
{
// TODO: Handle error.
}
// TODO: Use resp.
_
=
resp
}
func (*DocumentProcessorClient) GetEvaluation
func
(
c
*
DocumentProcessorClient
)
GetEvaluation
(
ctx
context
.
Context
,
req
*
documentaipb
.
GetEvaluationRequest
,
opts
...
gax
.
CallOption
)
(
*
documentaipb
.
Evaluation
,
error
)
GetEvaluation retrieves a specific evaluation.
Example
package
main
import
(
"context"
documentai
"cloud.google.com/go/documentai/apiv1beta3"
documentaipb
"cloud.google.com/go/documentai/apiv1beta3/documentaipb"
)
func
main
()
{
ctx
:=
context
.
Background
()
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating the service client as shown in:
// https://pkg.go.dev/cloud.google.com/go#hdr-Client_Options
c
,
err
:=
documentai
.
NewDocumentProcessorClient
(
ctx
)
if
err
!=
nil
{
// TODO: Handle error.
}
defer
c
.
Close
()
req
:=
& documentaipb
.
GetEvaluationRequest
{
// TODO: Fill request struct fields.
// See https://pkg.go.dev/cloud.google.com/go/documentai/apiv1beta3/documentaipb#GetEvaluationRequest.
}
resp
,
err
:=
c
.
GetEvaluation
(
ctx
,
req
)
if
err
!=
nil
{
// TODO: Handle error.
}
// TODO: Use resp.
_
=
resp
}
func (*DocumentProcessorClient) GetLocation
func
(
c
*
DocumentProcessorClient
)
GetLocation
(
ctx
context
.
Context
,
req
*
locationpb
.
GetLocationRequest
,
opts
...
gax
.
CallOption
)
(
*
locationpb
.
Location
,
error
)
GetLocation gets information about a location.
Example
package
main
import
(
"context"
documentai
"cloud.google.com/go/documentai/apiv1beta3"
locationpb
"google.golang.org/genproto/googleapis/cloud/location"
)
func
main
()
{
ctx
:=
context
.
Background
()
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating the service client as shown in:
// https://pkg.go.dev/cloud.google.com/go#hdr-Client_Options
c
,
err
:=
documentai
.
NewDocumentProcessorClient
(
ctx
)
if
err
!=
nil
{
// TODO: Handle error.
}
defer
c
.
Close
()
req
:=
& locationpb
.
GetLocationRequest
{
// TODO: Fill request struct fields.
// See https://pkg.go.dev/google.golang.org/genproto/googleapis/cloud/location#GetLocationRequest.
}
resp
,
err
:=
c
.
GetLocation
(
ctx
,
req
)
if
err
!=
nil
{
// TODO: Handle error.
}
// TODO: Use resp.
_
=
resp
}
func (*DocumentProcessorClient) GetOperation
func
(
c
*
DocumentProcessorClient
)
GetOperation
(
ctx
context
.
Context
,
req
*
longrunningpb
.
GetOperationRequest
,
opts
...
gax
.
CallOption
)
(
*
longrunningpb
.
Operation
,
error
)
GetOperation is a utility method from google.longrunning.Operations.
Example
package
main
import
(
"context"
documentai
"cloud.google.com/go/documentai/apiv1beta3"
longrunningpb
"cloud.google.com/go/longrunning/autogen/longrunningpb"
)
func
main
()
{
ctx
:=
context
.
Background
()
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating the service client as shown in:
// https://pkg.go.dev/cloud.google.com/go#hdr-Client_Options
c
,
err
:=
documentai
.
NewDocumentProcessorClient
(
ctx
)
if
err
!=
nil
{
// TODO: Handle error.
}
defer
c
.
Close
()
req
:=
& longrunningpb
.
GetOperationRequest
{
// TODO: Fill request struct fields.
// See https://pkg.go.dev/cloud.google.com/go/longrunning/autogen/longrunningpb#GetOperationRequest.
}
resp
,
err
:=
c
.
GetOperation
(
ctx
,
req
)
if
err
!=
nil
{
// TODO: Handle error.
}
// TODO: Use resp.
_
=
resp
}
func (*DocumentProcessorClient) GetProcessor
func
(
c
*
DocumentProcessorClient
)
GetProcessor
(
ctx
context
.
Context
,
req
*
documentaipb
.
GetProcessorRequest
,
opts
...
gax
.
CallOption
)
(
*
documentaipb
.
Processor
,
error
)
GetProcessor gets a processor detail.
Example
package
main
import
(
"context"
documentai
"cloud.google.com/go/documentai/apiv1beta3"
documentaipb
"cloud.google.com/go/documentai/apiv1beta3/documentaipb"
)
func
main
()
{
ctx
:=
context
.
Background
()
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating the service client as shown in:
// https://pkg.go.dev/cloud.google.com/go#hdr-Client_Options
c
,
err
:=
documentai
.
NewDocumentProcessorClient
(
ctx
)
if
err
!=
nil
{
// TODO: Handle error.
}
defer
c
.
Close
()
req
:=
& documentaipb
.
GetProcessorRequest
{
// TODO: Fill request struct fields.
// See https://pkg.go.dev/cloud.google.com/go/documentai/apiv1beta3/documentaipb#GetProcessorRequest.
}
resp
,
err
:=
c
.
GetProcessor
(
ctx
,
req
)
if
err
!=
nil
{
// TODO: Handle error.
}
// TODO: Use resp.
_
=
resp
}
func (*DocumentProcessorClient) GetProcessorType
func
(
c
*
DocumentProcessorClient
)
GetProcessorType
(
ctx
context
.
Context
,
req
*
documentaipb
.
GetProcessorTypeRequest
,
opts
...
gax
.
CallOption
)
(
*
documentaipb
.
ProcessorType
,
error
)
GetProcessorType gets a processor type detail.
Example
package
main
import
(
"context"
documentai
"cloud.google.com/go/documentai/apiv1beta3"
documentaipb
"cloud.google.com/go/documentai/apiv1beta3/documentaipb"
)
func
main
()
{
ctx
:=
context
.
Background
()
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating the service client as shown in:
// https://pkg.go.dev/cloud.google.com/go#hdr-Client_Options
c
,
err
:=
documentai
.
NewDocumentProcessorClient
(
ctx
)
if
err
!=
nil
{
// TODO: Handle error.
}
defer
c
.
Close
()
req
:=
& documentaipb
.
GetProcessorTypeRequest
{
// TODO: Fill request struct fields.
// See https://pkg.go.dev/cloud.google.com/go/documentai/apiv1beta3/documentaipb#GetProcessorTypeRequest.
}
resp
,
err
:=
c
.
GetProcessorType
(
ctx
,
req
)
if
err
!=
nil
{
// TODO: Handle error.
}
// TODO: Use resp.
_
=
resp
}
func (*DocumentProcessorClient) GetProcessorVersion
func
(
c
*
DocumentProcessorClient
)
GetProcessorVersion
(
ctx
context
.
Context
,
req
*
documentaipb
.
GetProcessorVersionRequest
,
opts
...
gax
.
CallOption
)
(
*
documentaipb
.
ProcessorVersion
,
error
)
GetProcessorVersion gets a processor version detail.
Example
package
main
import
(
"context"
documentai
"cloud.google.com/go/documentai/apiv1beta3"
documentaipb
"cloud.google.com/go/documentai/apiv1beta3/documentaipb"
)
func
main
()
{
ctx
:=
context
.
Background
()
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating the service client as shown in:
// https://pkg.go.dev/cloud.google.com/go#hdr-Client_Options
c
,
err
:=
documentai
.
NewDocumentProcessorClient
(
ctx
)
if
err
!=
nil
{
// TODO: Handle error.
}
defer
c
.
Close
()
req
:=
& documentaipb
.
GetProcessorVersionRequest
{
// TODO: Fill request struct fields.
// See https://pkg.go.dev/cloud.google.com/go/documentai/apiv1beta3/documentaipb#GetProcessorVersionRequest.
}
resp
,
err
:=
c
.
GetProcessorVersion
(
ctx
,
req
)
if
err
!=
nil
{
// TODO: Handle error.
}
// TODO: Use resp.
_
=
resp
}
func (*DocumentProcessorClient) ImportProcessorVersion
func
(
c
*
DocumentProcessorClient
)
ImportProcessorVersion
(
ctx
context
.
Context
,
req
*
documentaipb
.
ImportProcessorVersionRequest
,
opts
...
gax
.
CallOption
)
(
*
ImportProcessorVersionOperation
,
error
)
ImportProcessorVersion imports a processor version from source processor version.
Example
package
main
import
(
"context"
documentai
"cloud.google.com/go/documentai/apiv1beta3"
documentaipb
"cloud.google.com/go/documentai/apiv1beta3/documentaipb"
)
func
main
()
{
ctx
:=
context
.
Background
()
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating the service client as shown in:
// https://pkg.go.dev/cloud.google.com/go#hdr-Client_Options
c
,
err
:=
documentai
.
NewDocumentProcessorClient
(
ctx
)
if
err
!=
nil
{
// TODO: Handle error.
}
defer
c
.
Close
()
req
:=
& documentaipb
.
ImportProcessorVersionRequest
{
// TODO: Fill request struct fields.
// See https://pkg.go.dev/cloud.google.com/go/documentai/apiv1beta3/documentaipb#ImportProcessorVersionRequest.
}
op
,
err
:=
c
.
ImportProcessorVersion
(
ctx
,
req
)
if
err
!=
nil
{
// TODO: Handle error.
}
resp
,
err
:=
op
.
Wait
(
ctx
)
if
err
!=
nil
{
// TODO: Handle error.
}
// TODO: Use resp.
_
=
resp
}
func (*DocumentProcessorClient) ImportProcessorVersionOperation
func
(
c
*
DocumentProcessorClient
)
ImportProcessorVersionOperation
(
name
string
)
*
ImportProcessorVersionOperation
ImportProcessorVersionOperation returns a new ImportProcessorVersionOperation from a given name. The name must be that of a previously created ImportProcessorVersionOperation, possibly from a different process.
func (*DocumentProcessorClient) ListEvaluations
func
(
c
*
DocumentProcessorClient
)
ListEvaluations
(
ctx
context
.
Context
,
req
*
documentaipb
.
ListEvaluationsRequest
,
opts
...
gax
.
CallOption
)
*
EvaluationIterator
ListEvaluations retrieves a set of evaluations for a given processor version.
Example
package
main
import
(
"context"
documentai
"cloud.google.com/go/documentai/apiv1beta3"
documentaipb
"cloud.google.com/go/documentai/apiv1beta3/documentaipb"
"google.golang.org/api/iterator"
)
func
main
()
{
ctx
:=
context
.
Background
()
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating the service client as shown in:
// https://pkg.go.dev/cloud.google.com/go#hdr-Client_Options
c
,
err
:=
documentai
.
NewDocumentProcessorClient
(
ctx
)
if
err
!=
nil
{
// TODO: Handle error.
}
defer
c
.
Close
()
req
:=
& documentaipb
.
ListEvaluationsRequest
{
// TODO: Fill request struct fields.
// See https://pkg.go.dev/cloud.google.com/go/documentai/apiv1beta3/documentaipb#ListEvaluationsRequest.
}
it
:=
c
.
ListEvaluations
(
ctx
,
req
)
for
{
resp
,
err
:=
it
.
Next
()
if
err
==
iterator
.
Done
{
break
}
if
err
!=
nil
{
// TODO: Handle error.
}
// TODO: Use resp.
_
=
resp
// If you need to access the underlying RPC response,
// you can do so by casting the `Response` as below.
// Otherwise, remove this line. Only populated after
// first call to Next(). Not safe for concurrent access.
_
=
it
.
Response
.(
*
documentaipb
.
ListEvaluationsResponse
)
}
}
func (*DocumentProcessorClient) ListLocations
func
(
c
*
DocumentProcessorClient
)
ListLocations
(
ctx
context
.
Context
,
req
*
locationpb
.
ListLocationsRequest
,
opts
...
gax
.
CallOption
)
*
LocationIterator
ListLocations lists information about the supported locations for this service.
Example
package
main
import
(
"context"
documentai
"cloud.google.com/go/documentai/apiv1beta3"
"google.golang.org/api/iterator"
locationpb
"google.golang.org/genproto/googleapis/cloud/location"
)
func
main
()
{
ctx
:=
context
.
Background
()
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating the service client as shown in:
// https://pkg.go.dev/cloud.google.com/go#hdr-Client_Options
c
,
err
:=
documentai
.
NewDocumentProcessorClient
(
ctx
)
if
err
!=
nil
{
// TODO: Handle error.
}
defer
c
.
Close
()
req
:=
& locationpb
.
ListLocationsRequest
{
// TODO: Fill request struct fields.
// See https://pkg.go.dev/google.golang.org/genproto/googleapis/cloud/location#ListLocationsRequest.
}
it
:=
c
.
ListLocations
(
ctx
,
req
)
for
{
resp
,
err
:=
it
.
Next
()
if
err
==
iterator
.
Done
{
break
}
if
err
!=
nil
{
// TODO: Handle error.
}
// TODO: Use resp.
_
=
resp
// If you need to access the underlying RPC response,
// you can do so by casting the `Response` as below.
// Otherwise, remove this line. Only populated after
// first call to Next(). Not safe for concurrent access.
_
=
it
.
Response
.(
*
locationpb
.
ListLocationsResponse
)
}
}
func (*DocumentProcessorClient) ListOperations
func
(
c
*
DocumentProcessorClient
)
ListOperations
(
ctx
context
.
Context
,
req
*
longrunningpb
.
ListOperationsRequest
,
opts
...
gax
.
CallOption
)
*
OperationIterator
ListOperations is a utility method from google.longrunning.Operations.
Example
package
main
import
(
"context"
documentai
"cloud.google.com/go/documentai/apiv1beta3"
longrunningpb
"cloud.google.com/go/longrunning/autogen/longrunningpb"
"google.golang.org/api/iterator"
)
func
main
()
{
ctx
:=
context
.
Background
()
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating the service client as shown in:
// https://pkg.go.dev/cloud.google.com/go#hdr-Client_Options
c
,
err
:=
documentai
.
NewDocumentProcessorClient
(
ctx
)
if
err
!=
nil
{
// TODO: Handle error.
}
defer
c
.
Close
()
req
:=
& longrunningpb
.
ListOperationsRequest
{
// TODO: Fill request struct fields.
// See https://pkg.go.dev/cloud.google.com/go/longrunning/autogen/longrunningpb#ListOperationsRequest.
}
it
:=
c
.
ListOperations
(
ctx
,
req
)
for
{
resp
,
err
:=
it
.
Next
()
if
err
==
iterator
.
Done
{
break
}
if
err
!=
nil
{
// TODO: Handle error.
}
// TODO: Use resp.
_
=
resp
// If you need to access the underlying RPC response,
// you can do so by casting the `Response` as below.
// Otherwise, remove this line. Only populated after
// first call to Next(). Not safe for concurrent access.
_
=
it
.
Response
.(
*
longrunningpb
.
ListOperationsResponse
)
}
}
func (*DocumentProcessorClient) ListProcessorTypes
func
(
c
*
DocumentProcessorClient
)
ListProcessorTypes
(
ctx
context
.
Context
,
req
*
documentaipb
.
ListProcessorTypesRequest
,
opts
...
gax
.
CallOption
)
*
ProcessorTypeIterator
ListProcessorTypes lists the processor types that exist.
Example
package
main
import
(
"context"
documentai
"cloud.google.com/go/documentai/apiv1beta3"
documentaipb
"cloud.google.com/go/documentai/apiv1beta3/documentaipb"
"google.golang.org/api/iterator"
)
func
main
()
{
ctx
:=
context
.
Background
()
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating the service client as shown in:
// https://pkg.go.dev/cloud.google.com/go#hdr-Client_Options
c
,
err
:=
documentai
.
NewDocumentProcessorClient
(
ctx
)
if
err
!=
nil
{
// TODO: Handle error.
}
defer
c
.
Close
()
req
:=
& documentaipb
.
ListProcessorTypesRequest
{
// TODO: Fill request struct fields.
// See https://pkg.go.dev/cloud.google.com/go/documentai/apiv1beta3/documentaipb#ListProcessorTypesRequest.
}
it
:=
c
.
ListProcessorTypes
(
ctx
,
req
)
for
{
resp
,
err
:=
it
.
Next
()
if
err
==
iterator
.
Done
{
break
}
if
err
!=
nil
{
// TODO: Handle error.
}
// TODO: Use resp.
_
=
resp
// If you need to access the underlying RPC response,
// you can do so by casting the `Response` as below.
// Otherwise, remove this line. Only populated after
// first call to Next(). Not safe for concurrent access.
_
=
it
.
Response
.(
*
documentaipb
.
ListProcessorTypesResponse
)
}
}
func (*DocumentProcessorClient) ListProcessorVersions
func
(
c
*
DocumentProcessorClient
)
ListProcessorVersions
(
ctx
context
.
Context
,
req
*
documentaipb
.
ListProcessorVersionsRequest
,
opts
...
gax
.
CallOption
)
*
ProcessorVersionIterator
ListProcessorVersions lists all versions of a processor.
Example
package
main
import
(
"context"
documentai
"cloud.google.com/go/documentai/apiv1beta3"
documentaipb
"cloud.google.com/go/documentai/apiv1beta3/documentaipb"
"google.golang.org/api/iterator"
)
func
main
()
{
ctx
:=
context
.
Background
()
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating the service client as shown in:
// https://pkg.go.dev/cloud.google.com/go#hdr-Client_Options
c
,
err
:=
documentai
.
NewDocumentProcessorClient
(
ctx
)
if
err
!=
nil
{
// TODO: Handle error.
}
defer
c
.
Close
()
req
:=
& documentaipb
.
ListProcessorVersionsRequest
{
// TODO: Fill request struct fields.
// See https://pkg.go.dev/cloud.google.com/go/documentai/apiv1beta3/documentaipb#ListProcessorVersionsRequest.
}
it
:=
c
.
ListProcessorVersions
(
ctx
,
req
)
for
{
resp
,
err
:=
it
.
Next
()
if
err
==
iterator
.
Done
{
break
}
if
err
!=
nil
{
// TODO: Handle error.
}
// TODO: Use resp.
_
=
resp
// If you need to access the underlying RPC response,
// you can do so by casting the `Response` as below.
// Otherwise, remove this line. Only populated after
// first call to Next(). Not safe for concurrent access.
_
=
it
.
Response
.(
*
documentaipb
.
ListProcessorVersionsResponse
)
}
}
func (*DocumentProcessorClient) ListProcessors
func
(
c
*
DocumentProcessorClient
)
ListProcessors
(
ctx
context
.
Context
,
req
*
documentaipb
.
ListProcessorsRequest
,
opts
...
gax
.
CallOption
)
*
ProcessorIterator
ListProcessors lists all processors which belong to this project.
Example
package
main
import
(
"context"
documentai
"cloud.google.com/go/documentai/apiv1beta3"
documentaipb
"cloud.google.com/go/documentai/apiv1beta3/documentaipb"
"google.golang.org/api/iterator"
)
func
main
()
{
ctx
:=
context
.
Background
()
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating the service client as shown in:
// https://pkg.go.dev/cloud.google.com/go#hdr-Client_Options
c
,
err
:=
documentai
.
NewDocumentProcessorClient
(
ctx
)
if
err
!=
nil
{
// TODO: Handle error.
}
defer
c
.
Close
()
req
:=
& documentaipb
.
ListProcessorsRequest
{
// TODO: Fill request struct fields.
// See https://pkg.go.dev/cloud.google.com/go/documentai/apiv1beta3/documentaipb#ListProcessorsRequest.
}
it
:=
c
.
ListProcessors
(
ctx
,
req
)
for
{
resp
,
err
:=
it
.
Next
()
if
err
==
iterator
.
Done
{
break
}
if
err
!=
nil
{
// TODO: Handle error.
}
// TODO: Use resp.
_
=
resp
// If you need to access the underlying RPC response,
// you can do so by casting the `Response` as below.
// Otherwise, remove this line. Only populated after
// first call to Next(). Not safe for concurrent access.
_
=
it
.
Response
.(
*
documentaipb
.
ListProcessorsResponse
)
}
}
func (*DocumentProcessorClient) ProcessDocument
func
(
c
*
DocumentProcessorClient
)
ProcessDocument
(
ctx
context
.
Context
,
req
*
documentaipb
.
ProcessRequest
,
opts
...
gax
.
CallOption
)
(
*
documentaipb
.
ProcessResponse
,
error
)
ProcessDocument processes a single document.
Example
package
main
import
(
"context"
documentai
"cloud.google.com/go/documentai/apiv1beta3"
documentaipb
"cloud.google.com/go/documentai/apiv1beta3/documentaipb"
)
func
main
()
{
ctx
:=
context
.
Background
()
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating the service client as shown in:
// https://pkg.go.dev/cloud.google.com/go#hdr-Client_Options
c
,
err
:=
documentai
.
NewDocumentProcessorClient
(
ctx
)
if
err
!=
nil
{
// TODO: Handle error.
}
defer
c
.
Close
()
req
:=
& documentaipb
.
ProcessRequest
{
// TODO: Fill request struct fields.
// See https://pkg.go.dev/cloud.google.com/go/documentai/apiv1beta3/documentaipb#ProcessRequest.
}
resp
,
err
:=
c
.
ProcessDocument
(
ctx
,
req
)
if
err
!=
nil
{
// TODO: Handle error.
}
// TODO: Use resp.
_
=
resp
}
func (*DocumentProcessorClient) ReviewDocument
func
(
c
*
DocumentProcessorClient
)
ReviewDocument
(
ctx
context
.
Context
,
req
*
documentaipb
.
ReviewDocumentRequest
,
opts
...
gax
.
CallOption
)
(
*
ReviewDocumentOperation
,
error
)
ReviewDocument send a document for Human Review. The input document should be processed by the specified processor.
Example
package
main
import
(
"context"
documentai
"cloud.google.com/go/documentai/apiv1beta3"
documentaipb
"cloud.google.com/go/documentai/apiv1beta3/documentaipb"
)
func
main
()
{
ctx
:=
context
.
Background
()
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating the service client as shown in:
// https://pkg.go.dev/cloud.google.com/go#hdr-Client_Options
c
,
err
:=
documentai
.
NewDocumentProcessorClient
(
ctx
)
if
err
!=
nil
{
// TODO: Handle error.
}
defer
c
.
Close
()
req
:=
& documentaipb
.
ReviewDocumentRequest
{
// TODO: Fill request struct fields.
// See https://pkg.go.dev/cloud.google.com/go/documentai/apiv1beta3/documentaipb#ReviewDocumentRequest.
}
op
,
err
:=
c
.
ReviewDocument
(
ctx
,
req
)
if
err
!=
nil
{
// TODO: Handle error.
}
resp
,
err
:=
op
.
Wait
(
ctx
)
if
err
!=
nil
{
// TODO: Handle error.
}
// TODO: Use resp.
_
=
resp
}
func (*DocumentProcessorClient) ReviewDocumentOperation
func
(
c
*
DocumentProcessorClient
)
ReviewDocumentOperation
(
name
string
)
*
ReviewDocumentOperation
ReviewDocumentOperation returns a new ReviewDocumentOperation from a given name. The name must be that of a previously created ReviewDocumentOperation, possibly from a different process.
func (*DocumentProcessorClient) SetDefaultProcessorVersion
func
(
c
*
DocumentProcessorClient
)
SetDefaultProcessorVersion
(
ctx
context
.
Context
,
req
*
documentaipb
.
SetDefaultProcessorVersionRequest
,
opts
...
gax
.
CallOption
)
(
*
SetDefaultProcessorVersionOperation
,
error
)
SetDefaultProcessorVersion set the default (active) version of a Processor that will be used in ProcessDocument and BatchProcessDocuments.
Example
package
main
import
(
"context"
documentai
"cloud.google.com/go/documentai/apiv1beta3"
documentaipb
"cloud.google.com/go/documentai/apiv1beta3/documentaipb"
)
func
main
()
{
ctx
:=
context
.
Background
()
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating the service client as shown in:
// https://pkg.go.dev/cloud.google.com/go#hdr-Client_Options
c
,
err
:=
documentai
.
NewDocumentProcessorClient
(
ctx
)
if
err
!=
nil
{
// TODO: Handle error.
}
defer
c
.
Close
()
req
:=
& documentaipb
.
SetDefaultProcessorVersionRequest
{
// TODO: Fill request struct fields.
// See https://pkg.go.dev/cloud.google.com/go/documentai/apiv1beta3/documentaipb#SetDefaultProcessorVersionRequest.
}
op
,
err
:=
c
.
SetDefaultProcessorVersion
(
ctx
,
req
)
if
err
!=
nil
{
// TODO: Handle error.
}
resp
,
err
:=
op
.
Wait
(
ctx
)
if
err
!=
nil
{
// TODO: Handle error.
}
// TODO: Use resp.
_
=
resp
}
func (*DocumentProcessorClient) SetDefaultProcessorVersionOperation
func
(
c
*
DocumentProcessorClient
)
SetDefaultProcessorVersionOperation
(
name
string
)
*
SetDefaultProcessorVersionOperation
SetDefaultProcessorVersionOperation returns a new SetDefaultProcessorVersionOperation from a given name. The name must be that of a previously created SetDefaultProcessorVersionOperation, possibly from a different process.
func (*DocumentProcessorClient) TrainProcessorVersion
func
(
c
*
DocumentProcessorClient
)
TrainProcessorVersion
(
ctx
context
.
Context
,
req
*
documentaipb
.
TrainProcessorVersionRequest
,
opts
...
gax
.
CallOption
)
(
*
TrainProcessorVersionOperation
,
error
)
TrainProcessorVersion trains a new processor version. Operation metadata is returned as TrainProcessorVersionMetadata.
Example
package
main
import
(
"context"
documentai
"cloud.google.com/go/documentai/apiv1beta3"
documentaipb
"cloud.google.com/go/documentai/apiv1beta3/documentaipb"
)
func
main
()
{
ctx
:=
context
.
Background
()
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating the service client as shown in:
// https://pkg.go.dev/cloud.google.com/go#hdr-Client_Options
c
,
err
:=
documentai
.
NewDocumentProcessorClient
(
ctx
)
if
err
!=
nil
{
// TODO: Handle error.
}
defer
c
.
Close
()
req
:=
& documentaipb
.
TrainProcessorVersionRequest
{
// TODO: Fill request struct fields.
// See https://pkg.go.dev/cloud.google.com/go/documentai/apiv1beta3/documentaipb#TrainProcessorVersionRequest.
}
op
,
err
:=
c
.
TrainProcessorVersion
(
ctx
,
req
)
if
err
!=
nil
{
// TODO: Handle error.
}
resp
,
err
:=
op
.
Wait
(
ctx
)
if
err
!=
nil
{
// TODO: Handle error.
}
// TODO: Use resp.
_
=
resp
}
func (*DocumentProcessorClient) TrainProcessorVersionOperation
func
(
c
*
DocumentProcessorClient
)
TrainProcessorVersionOperation
(
name
string
)
*
TrainProcessorVersionOperation
TrainProcessorVersionOperation returns a new TrainProcessorVersionOperation from a given name. The name must be that of a previously created TrainProcessorVersionOperation, possibly from a different process.
func (*DocumentProcessorClient) UndeployProcessorVersion
func
(
c
*
DocumentProcessorClient
)
UndeployProcessorVersion
(
ctx
context
.
Context
,
req
*
documentaipb
.
UndeployProcessorVersionRequest
,
opts
...
gax
.
CallOption
)
(
*
UndeployProcessorVersionOperation
,
error
)
UndeployProcessorVersion undeploys the processor version.
Example
package
main
import
(
"context"
documentai
"cloud.google.com/go/documentai/apiv1beta3"
documentaipb
"cloud.google.com/go/documentai/apiv1beta3/documentaipb"
)
func
main
()
{
ctx
:=
context
.
Background
()
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating the service client as shown in:
// https://pkg.go.dev/cloud.google.com/go#hdr-Client_Options
c
,
err
:=
documentai
.
NewDocumentProcessorClient
(
ctx
)
if
err
!=
nil
{
// TODO: Handle error.
}
defer
c
.
Close
()
req
:=
& documentaipb
.
UndeployProcessorVersionRequest
{
// TODO: Fill request struct fields.
// See https://pkg.go.dev/cloud.google.com/go/documentai/apiv1beta3/documentaipb#UndeployProcessorVersionRequest.
}
op
,
err
:=
c
.
UndeployProcessorVersion
(
ctx
,
req
)
if
err
!=
nil
{
// TODO: Handle error.
}
resp
,
err
:=
op
.
Wait
(
ctx
)
if
err
!=
nil
{
// TODO: Handle error.
}
// TODO: Use resp.
_
=
resp
}
func (*DocumentProcessorClient) UndeployProcessorVersionOperation
func
(
c
*
DocumentProcessorClient
)
UndeployProcessorVersionOperation
(
name
string
)
*
UndeployProcessorVersionOperation
UndeployProcessorVersionOperation returns a new UndeployProcessorVersionOperation from a given name. The name must be that of a previously created UndeployProcessorVersionOperation, possibly from a different process.
EnableProcessorOperation
type
EnableProcessorOperation
struct
{
// contains filtered or unexported fields
}
EnableProcessorOperation manages a long-running operation from EnableProcessor.
func (*EnableProcessorOperation) Done
func
(
op
*
EnableProcessorOperation
)
Done
()
bool
Done reports whether the long-running operation has completed.
func (*EnableProcessorOperation) Metadata
func
(
op
*
EnableProcessorOperation
)
Metadata
()
(
*
documentaipb
.
EnableProcessorMetadata
,
error
)
Metadata returns metadata associated with the long-running operation. Metadata itself does not contact the server, but Poll does. To get the latest metadata, call this method after a successful call to Poll. If the metadata is not available, the returned metadata and error are both nil.
func (*EnableProcessorOperation) Name
func
(
op
*
EnableProcessorOperation
)
Name
()
string
Name returns the name of the long-running operation. The name is assigned by the server and is unique within the service from which the operation is created.
func (*EnableProcessorOperation) Poll
func
(
op
*
EnableProcessorOperation
)
Poll
(
ctx
context
.
Context
,
opts
...
gax
.
CallOption
)
(
*
documentaipb
.
EnableProcessorResponse
,
error
)
Poll fetches the latest state of the long-running operation.
Poll also fetches the latest metadata, which can be retrieved by Metadata.
If Poll fails, the error is returned and op is unmodified. If Poll succeeds and the operation has completed with failure, the error is returned and op.Done will return true. If Poll succeeds and the operation has completed successfully, op.Done will return true, and the response of the operation is returned. If Poll succeeds and the operation has not completed, the returned response and error are both nil.
func (*EnableProcessorOperation) Wait
func
(
op
*
EnableProcessorOperation
)
Wait
(
ctx
context
.
Context
,
opts
...
gax
.
CallOption
)
(
*
documentaipb
.
EnableProcessorResponse
,
error
)
Wait blocks until the long-running operation is completed, returning the response and any errors encountered.
See documentation of Poll for error-handling information.
EvaluateProcessorVersionOperation
type
EvaluateProcessorVersionOperation
struct
{
// contains filtered or unexported fields
}
EvaluateProcessorVersionOperation manages a long-running operation from EvaluateProcessorVersion.
func (*EvaluateProcessorVersionOperation) Done
func
(
op
*
EvaluateProcessorVersionOperation
)
Done
()
bool
Done reports whether the long-running operation has completed.
func (*EvaluateProcessorVersionOperation) Metadata
func
(
op
*
EvaluateProcessorVersionOperation
)
Metadata
()
(
*
documentaipb
.
EvaluateProcessorVersionMetadata
,
error
)
Metadata returns metadata associated with the long-running operation. Metadata itself does not contact the server, but Poll does. To get the latest metadata, call this method after a successful call to Poll. If the metadata is not available, the returned metadata and error are both nil.
func (*EvaluateProcessorVersionOperation) Name
func
(
op
*
EvaluateProcessorVersionOperation
)
Name
()
string
Name returns the name of the long-running operation. The name is assigned by the server and is unique within the service from which the operation is created.
func (*EvaluateProcessorVersionOperation) Poll
func
(
op
*
EvaluateProcessorVersionOperation
)
Poll
(
ctx
context
.
Context
,
opts
...
gax
.
CallOption
)
(
*
documentaipb
.
EvaluateProcessorVersionResponse
,
error
)
Poll fetches the latest state of the long-running operation.
Poll also fetches the latest metadata, which can be retrieved by Metadata.
If Poll fails, the error is returned and op is unmodified. If Poll succeeds and the operation has completed with failure, the error is returned and op.Done will return true. If Poll succeeds and the operation has completed successfully, op.Done will return true, and the response of the operation is returned. If Poll succeeds and the operation has not completed, the returned response and error are both nil.
func (*EvaluateProcessorVersionOperation) Wait
func
(
op
*
EvaluateProcessorVersionOperation
)
Wait
(
ctx
context
.
Context
,
opts
...
gax
.
CallOption
)
(
*
documentaipb
.
EvaluateProcessorVersionResponse
,
error
)
Wait blocks until the long-running operation is completed, returning the response and any errors encountered.
See documentation of Poll for error-handling information.
EvaluationIterator
type
EvaluationIterator
struct
{
// Response is the raw response for the current page.
// It must be cast to the RPC response type.
// Calling Next() or InternalFetch() updates this value.
Response
interface
{}
// InternalFetch is for use by the Google Cloud Libraries only.
// It is not part of the stable interface of this package.
//
// InternalFetch returns results from a single call to the underlying RPC.
// The number of results is no greater than pageSize.
// If there are no more results, nextPageToken is empty and err is nil.
InternalFetch
func
(
pageSize
int
,
pageToken
string
)
(
results
[]
*
documentaipb
.
Evaluation
,
nextPageToken
string
,
err
error
)
// contains filtered or unexported fields
}
EvaluationIterator manages a stream of *documentaipb.Evaluation.
func (*EvaluationIterator) Next
func
(
it
*
EvaluationIterator
)
Next
()
(
*
documentaipb
.
Evaluation
,
error
)
Next returns the next result. Its second return value is iterator.Done if there are no more results. Once Next returns Done, all subsequent calls will return Done.
func (*EvaluationIterator) PageInfo
func
(
it
*
EvaluationIterator
)
PageInfo
()
*
iterator
.
PageInfo
PageInfo supports pagination. See the google.golang.org/api/iterator package for details.
ImportDocumentsOperation
type
ImportDocumentsOperation
struct
{
// contains filtered or unexported fields
}
ImportDocumentsOperation manages a long-running operation from ImportDocuments.
func (*ImportDocumentsOperation) Done
func
(
op
*
ImportDocumentsOperation
)
Done
()
bool
Done reports whether the long-running operation has completed.
func (*ImportDocumentsOperation) Metadata
func
(
op
*
ImportDocumentsOperation
)
Metadata
()
(
*
documentaipb
.
ImportDocumentsMetadata
,
error
)
Metadata returns metadata associated with the long-running operation. Metadata itself does not contact the server, but Poll does. To get the latest metadata, call this method after a successful call to Poll. If the metadata is not available, the returned metadata and error are both nil.
func (*ImportDocumentsOperation) Name
func
(
op
*
ImportDocumentsOperation
)
Name
()
string
Name returns the name of the long-running operation. The name is assigned by the server and is unique within the service from which the operation is created.
func (*ImportDocumentsOperation) Poll
func
(
op
*
ImportDocumentsOperation
)
Poll
(
ctx
context
.
Context
,
opts
...
gax
.
CallOption
)
(
*
documentaipb
.
ImportDocumentsResponse
,
error
)
Poll fetches the latest state of the long-running operation.
Poll also fetches the latest metadata, which can be retrieved by Metadata.
If Poll fails, the error is returned and op is unmodified. If Poll succeeds and the operation has completed with failure, the error is returned and op.Done will return true. If Poll succeeds and the operation has completed successfully, op.Done will return true, and the response of the operation is returned. If Poll succeeds and the operation has not completed, the returned response and error are both nil.
func (*ImportDocumentsOperation) Wait
func
(
op
*
ImportDocumentsOperation
)
Wait
(
ctx
context
.
Context
,
opts
...
gax
.
CallOption
)
(
*
documentaipb
.
ImportDocumentsResponse
,
error
)
Wait blocks until the long-running operation is completed, returning the response and any errors encountered.
See documentation of Poll for error-handling information.
ImportProcessorVersionOperation
type
ImportProcessorVersionOperation
struct
{
// contains filtered or unexported fields
}
ImportProcessorVersionOperation manages a long-running operation from ImportProcessorVersion.
func (*ImportProcessorVersionOperation) Done
func
(
op
*
ImportProcessorVersionOperation
)
Done
()
bool
Done reports whether the long-running operation has completed.
func (*ImportProcessorVersionOperation) Metadata
func
(
op
*
ImportProcessorVersionOperation
)
Metadata
()
(
*
documentaipb
.
ImportProcessorVersionMetadata
,
error
)
Metadata returns metadata associated with the long-running operation. Metadata itself does not contact the server, but Poll does. To get the latest metadata, call this method after a successful call to Poll. If the metadata is not available, the returned metadata and error are both nil.
func (*ImportProcessorVersionOperation) Name
func
(
op
*
ImportProcessorVersionOperation
)
Name
()
string
Name returns the name of the long-running operation. The name is assigned by the server and is unique within the service from which the operation is created.
func (*ImportProcessorVersionOperation) Poll
func
(
op
*
ImportProcessorVersionOperation
)
Poll
(
ctx
context
.
Context
,
opts
...
gax
.
CallOption
)
(
*
documentaipb
.
ImportProcessorVersionResponse
,
error
)
Poll fetches the latest state of the long-running operation.
Poll also fetches the latest metadata, which can be retrieved by Metadata.
If Poll fails, the error is returned and op is unmodified. If Poll succeeds and the operation has completed with failure, the error is returned and op.Done will return true. If Poll succeeds and the operation has completed successfully, op.Done will return true, and the response of the operation is returned. If Poll succeeds and the operation has not completed, the returned response and error are both nil.
func (*ImportProcessorVersionOperation) Wait
func
(
op
*
ImportProcessorVersionOperation
)
Wait
(
ctx
context
.
Context
,
opts
...
gax
.
CallOption
)
(
*
documentaipb
.
ImportProcessorVersionResponse
,
error
)
Wait blocks until the long-running operation is completed, returning the response and any errors encountered.
See documentation of Poll for error-handling information.
LocationIterator
type
LocationIterator
struct
{
// Response is the raw response for the current page.
// It must be cast to the RPC response type.
// Calling Next() or InternalFetch() updates this value.
Response
interface
{}
// InternalFetch is for use by the Google Cloud Libraries only.
// It is not part of the stable interface of this package.
//
// InternalFetch returns results from a single call to the underlying RPC.
// The number of results is no greater than pageSize.
// If there are no more results, nextPageToken is empty and err is nil.
InternalFetch
func
(
pageSize
int
,
pageToken
string
)
(
results
[]
*
locationpb
.
Location
,
nextPageToken
string
,
err
error
)
// contains filtered or unexported fields
}
LocationIterator manages a stream of *locationpb.Location.
func (*LocationIterator) Next
func
(
it
*
LocationIterator
)
Next
()
(
*
locationpb
.
Location
,
error
)
Next returns the next result. Its second return value is iterator.Done if there are no more results. Once Next returns Done, all subsequent calls will return Done.
func (*LocationIterator) PageInfo
func
(
it
*
LocationIterator
)
PageInfo
()
*
iterator
.
PageInfo
PageInfo supports pagination. See the google.golang.org/api/iterator package for details.
OperationIterator
type
OperationIterator
struct
{
// Response is the raw response for the current page.
// It must be cast to the RPC response type.
// Calling Next() or InternalFetch() updates this value.
Response
interface
{}
// InternalFetch is for use by the Google Cloud Libraries only.
// It is not part of the stable interface of this package.
//
// InternalFetch returns results from a single call to the underlying RPC.
// The number of results is no greater than pageSize.
// If there are no more results, nextPageToken is empty and err is nil.
InternalFetch
func
(
pageSize
int
,
pageToken
string
)
(
results
[]
*
longrunningpb
.
Operation
,
nextPageToken
string
,
err
error
)
// contains filtered or unexported fields
}
OperationIterator manages a stream of *longrunningpb.Operation.
func (*OperationIterator) Next
func
(
it
*
OperationIterator
)
Next
()
(
*
longrunningpb
.
Operation
,
error
)
Next returns the next result. Its second return value is iterator.Done if there are no more results. Once Next returns Done, all subsequent calls will return Done.
func (*OperationIterator) PageInfo
func
(
it
*
OperationIterator
)
PageInfo
()
*
iterator
.
PageInfo
PageInfo supports pagination. See the google.golang.org/api/iterator package for details.
ProcessorIterator
type
ProcessorIterator
struct
{
// Response is the raw response for the current page.
// It must be cast to the RPC response type.
// Calling Next() or InternalFetch() updates this value.
Response
interface
{}
// InternalFetch is for use by the Google Cloud Libraries only.
// It is not part of the stable interface of this package.
//
// InternalFetch returns results from a single call to the underlying RPC.
// The number of results is no greater than pageSize.
// If there are no more results, nextPageToken is empty and err is nil.
InternalFetch
func
(
pageSize
int
,
pageToken
string
)
(
results
[]
*
documentaipb
.
Processor
,
nextPageToken
string
,
err
error
)
// contains filtered or unexported fields
}
ProcessorIterator manages a stream of *documentaipb.Processor.
func (*ProcessorIterator) Next
func
(
it
*
ProcessorIterator
)
Next
()
(
*
documentaipb
.
Processor
,
error
)
Next returns the next result. Its second return value is iterator.Done if there are no more results. Once Next returns Done, all subsequent calls will return Done.
func (*ProcessorIterator) PageInfo
func
(
it
*
ProcessorIterator
)
PageInfo
()
*
iterator
.
PageInfo
PageInfo supports pagination. See the google.golang.org/api/iterator package for details.
ProcessorTypeIterator
type
ProcessorTypeIterator
struct
{
// Response is the raw response for the current page.
// It must be cast to the RPC response type.
// Calling Next() or InternalFetch() updates this value.
Response
interface
{}
// InternalFetch is for use by the Google Cloud Libraries only.
// It is not part of the stable interface of this package.
//
// InternalFetch returns results from a single call to the underlying RPC.
// The number of results is no greater than pageSize.
// If there are no more results, nextPageToken is empty and err is nil.
InternalFetch
func
(
pageSize
int
,
pageToken
string
)
(
results
[]
*
documentaipb
.
ProcessorType
,
nextPageToken
string
,
err
error
)
// contains filtered or unexported fields
}
ProcessorTypeIterator manages a stream of *documentaipb.ProcessorType.
func (*ProcessorTypeIterator) Next
func
(
it
*
ProcessorTypeIterator
)
Next
()
(
*
documentaipb
.
ProcessorType
,
error
)
Next returns the next result. Its second return value is iterator.Done if there are no more results. Once Next returns Done, all subsequent calls will return Done.
func (*ProcessorTypeIterator) PageInfo
func
(
it
*
ProcessorTypeIterator
)
PageInfo
()
*
iterator
.
PageInfo
PageInfo supports pagination. See the google.golang.org/api/iterator package for details.
ProcessorVersionIterator
type
ProcessorVersionIterator
struct
{
// Response is the raw response for the current page.
// It must be cast to the RPC response type.
// Calling Next() or InternalFetch() updates this value.
Response
interface
{}
// InternalFetch is for use by the Google Cloud Libraries only.
// It is not part of the stable interface of this package.
//
// InternalFetch returns results from a single call to the underlying RPC.
// The number of results is no greater than pageSize.
// If there are no more results, nextPageToken is empty and err is nil.
InternalFetch
func
(
pageSize
int
,
pageToken
string
)
(
results
[]
*
documentaipb
.
ProcessorVersion
,
nextPageToken
string
,
err
error
)
// contains filtered or unexported fields
}
ProcessorVersionIterator manages a stream of *documentaipb.ProcessorVersion.
func (*ProcessorVersionIterator) Next
func
(
it
*
ProcessorVersionIterator
)
Next
()
(
*
documentaipb
.
ProcessorVersion
,
error
)
Next returns the next result. Its second return value is iterator.Done if there are no more results. Once Next returns Done, all subsequent calls will return Done.
func (*ProcessorVersionIterator) PageInfo
func
(
it
*
ProcessorVersionIterator
)
PageInfo
()
*
iterator
.
PageInfo
PageInfo supports pagination. See the google.golang.org/api/iterator package for details.
ReviewDocumentOperation
type
ReviewDocumentOperation
struct
{
// contains filtered or unexported fields
}
ReviewDocumentOperation manages a long-running operation from ReviewDocument.
func (*ReviewDocumentOperation) Done
func
(
op
*
ReviewDocumentOperation
)
Done
()
bool
Done reports whether the long-running operation has completed.
func (*ReviewDocumentOperation) Metadata
func
(
op
*
ReviewDocumentOperation
)
Metadata
()
(
*
documentaipb
.
ReviewDocumentOperationMetadata
,
error
)
Metadata returns metadata associated with the long-running operation. Metadata itself does not contact the server, but Poll does. To get the latest metadata, call this method after a successful call to Poll. If the metadata is not available, the returned metadata and error are both nil.
func (*ReviewDocumentOperation) Name
func
(
op
*
ReviewDocumentOperation
)
Name
()
string
Name returns the name of the long-running operation. The name is assigned by the server and is unique within the service from which the operation is created.
func (*ReviewDocumentOperation) Poll
func
(
op
*
ReviewDocumentOperation
)
Poll
(
ctx
context
.
Context
,
opts
...
gax
.
CallOption
)
(
*
documentaipb
.
ReviewDocumentResponse
,
error
)
Poll fetches the latest state of the long-running operation.
Poll also fetches the latest metadata, which can be retrieved by Metadata.
If Poll fails, the error is returned and op is unmodified. If Poll succeeds and the operation has completed with failure, the error is returned and op.Done will return true. If Poll succeeds and the operation has completed successfully, op.Done will return true, and the response of the operation is returned. If Poll succeeds and the operation has not completed, the returned response and error are both nil.
func (*ReviewDocumentOperation) Wait
func
(
op
*
ReviewDocumentOperation
)
Wait
(
ctx
context
.
Context
,
opts
...
gax
.
CallOption
)
(
*
documentaipb
.
ReviewDocumentResponse
,
error
)
Wait blocks until the long-running operation is completed, returning the response and any errors encountered.
See documentation of Poll for error-handling information.
SetDefaultProcessorVersionOperation
type
SetDefaultProcessorVersionOperation
struct
{
// contains filtered or unexported fields
}
SetDefaultProcessorVersionOperation manages a long-running operation from SetDefaultProcessorVersion.
func (*SetDefaultProcessorVersionOperation) Done
func
(
op
*
SetDefaultProcessorVersionOperation
)
Done
()
bool
Done reports whether the long-running operation has completed.
func (*SetDefaultProcessorVersionOperation) Metadata
func
(
op
*
SetDefaultProcessorVersionOperation
)
Metadata
()
(
*
documentaipb
.
SetDefaultProcessorVersionMetadata
,
error
)
Metadata returns metadata associated with the long-running operation. Metadata itself does not contact the server, but Poll does. To get the latest metadata, call this method after a successful call to Poll. If the metadata is not available, the returned metadata and error are both nil.
func (*SetDefaultProcessorVersionOperation) Name
func
(
op
*
SetDefaultProcessorVersionOperation
)
Name
()
string
Name returns the name of the long-running operation. The name is assigned by the server and is unique within the service from which the operation is created.
func (*SetDefaultProcessorVersionOperation) Poll
func
(
op
*
SetDefaultProcessorVersionOperation
)
Poll
(
ctx
context
.
Context
,
opts
...
gax
.
CallOption
)
(
*
documentaipb
.
SetDefaultProcessorVersionResponse
,
error
)
Poll fetches the latest state of the long-running operation.
Poll also fetches the latest metadata, which can be retrieved by Metadata.
If Poll fails, the error is returned and op is unmodified. If Poll succeeds and the operation has completed with failure, the error is returned and op.Done will return true. If Poll succeeds and the operation has completed successfully, op.Done will return true, and the response of the operation is returned. If Poll succeeds and the operation has not completed, the returned response and error are both nil.
func (*SetDefaultProcessorVersionOperation) Wait
func
(
op
*
SetDefaultProcessorVersionOperation
)
Wait
(
ctx
context
.
Context
,
opts
...
gax
.
CallOption
)
(
*
documentaipb
.
SetDefaultProcessorVersionResponse
,
error
)
Wait blocks until the long-running operation is completed, returning the response and any errors encountered.
See documentation of Poll for error-handling information.
TrainProcessorVersionOperation
type
TrainProcessorVersionOperation
struct
{
// contains filtered or unexported fields
}
TrainProcessorVersionOperation manages a long-running operation from TrainProcessorVersion.
func (*TrainProcessorVersionOperation) Done
func
(
op
*
TrainProcessorVersionOperation
)
Done
()
bool
Done reports whether the long-running operation has completed.
func (*TrainProcessorVersionOperation) Metadata
func
(
op
*
TrainProcessorVersionOperation
)
Metadata
()
(
*
documentaipb
.
TrainProcessorVersionMetadata
,
error
)
Metadata returns metadata associated with the long-running operation. Metadata itself does not contact the server, but Poll does. To get the latest metadata, call this method after a successful call to Poll. If the metadata is not available, the returned metadata and error are both nil.
func (*TrainProcessorVersionOperation) Name
func
(
op
*
TrainProcessorVersionOperation
)
Name
()
string
Name returns the name of the long-running operation. The name is assigned by the server and is unique within the service from which the operation is created.
func (*TrainProcessorVersionOperation) Poll
func
(
op
*
TrainProcessorVersionOperation
)
Poll
(
ctx
context
.
Context
,
opts
...
gax
.
CallOption
)
(
*
documentaipb
.
TrainProcessorVersionResponse
,
error
)
Poll fetches the latest state of the long-running operation.
Poll also fetches the latest metadata, which can be retrieved by Metadata.
If Poll fails, the error is returned and op is unmodified. If Poll succeeds and the operation has completed with failure, the error is returned and op.Done will return true. If Poll succeeds and the operation has completed successfully, op.Done will return true, and the response of the operation is returned. If Poll succeeds and the operation has not completed, the returned response and error are both nil.
func (*TrainProcessorVersionOperation) Wait
func
(
op
*
TrainProcessorVersionOperation
)
Wait
(
ctx
context
.
Context
,
opts
...
gax
.
CallOption
)
(
*
documentaipb
.
TrainProcessorVersionResponse
,
error
)
Wait blocks until the long-running operation is completed, returning the response and any errors encountered.
See documentation of Poll for error-handling information.
UndeployProcessorVersionOperation
type
UndeployProcessorVersionOperation
struct
{
// contains filtered or unexported fields
}
UndeployProcessorVersionOperation manages a long-running operation from UndeployProcessorVersion.
func (*UndeployProcessorVersionOperation) Done
func
(
op
*
UndeployProcessorVersionOperation
)
Done
()
bool
Done reports whether the long-running operation has completed.
func (*UndeployProcessorVersionOperation) Metadata
func
(
op
*
UndeployProcessorVersionOperation
)
Metadata
()
(
*
documentaipb
.
UndeployProcessorVersionMetadata
,
error
)
Metadata returns metadata associated with the long-running operation. Metadata itself does not contact the server, but Poll does. To get the latest metadata, call this method after a successful call to Poll. If the metadata is not available, the returned metadata and error are both nil.
func (*UndeployProcessorVersionOperation) Name
func
(
op
*
UndeployProcessorVersionOperation
)
Name
()
string
Name returns the name of the long-running operation. The name is assigned by the server and is unique within the service from which the operation is created.
func (*UndeployProcessorVersionOperation) Poll
func
(
op
*
UndeployProcessorVersionOperation
)
Poll
(
ctx
context
.
Context
,
opts
...
gax
.
CallOption
)
(
*
documentaipb
.
UndeployProcessorVersionResponse
,
error
)
Poll fetches the latest state of the long-running operation.
Poll also fetches the latest metadata, which can be retrieved by Metadata.
If Poll fails, the error is returned and op is unmodified. If Poll succeeds and the operation has completed with failure, the error is returned and op.Done will return true. If Poll succeeds and the operation has completed successfully, op.Done will return true, and the response of the operation is returned. If Poll succeeds and the operation has not completed, the returned response and error are both nil.
func (*UndeployProcessorVersionOperation) Wait
func
(
op
*
UndeployProcessorVersionOperation
)
Wait
(
ctx
context
.
Context
,
opts
...
gax
.
CallOption
)
(
*
documentaipb
.
UndeployProcessorVersionResponse
,
error
)
Wait blocks until the long-running operation is completed, returning the response and any errors encountered.
See documentation of Poll for error-handling information.
UpdateDatasetOperation
type
UpdateDatasetOperation
struct
{
// contains filtered or unexported fields
}
UpdateDatasetOperation manages a long-running operation from UpdateDataset.
func (*UpdateDatasetOperation) Done
func
(
op
*
UpdateDatasetOperation
)
Done
()
bool
Done reports whether the long-running operation has completed.
func (*UpdateDatasetOperation) Metadata
func
(
op
*
UpdateDatasetOperation
)
Metadata
()
(
*
documentaipb
.
UpdateDatasetOperationMetadata
,
error
)
Metadata returns metadata associated with the long-running operation. Metadata itself does not contact the server, but Poll does. To get the latest metadata, call this method after a successful call to Poll. If the metadata is not available, the returned metadata and error are both nil.
func (*UpdateDatasetOperation) Name
func
(
op
*
UpdateDatasetOperation
)
Name
()
string
Name returns the name of the long-running operation. The name is assigned by the server and is unique within the service from which the operation is created.
func (*UpdateDatasetOperation) Poll
func
(
op
*
UpdateDatasetOperation
)
Poll
(
ctx
context
.
Context
,
opts
...
gax
.
CallOption
)
(
*
documentaipb
.
Dataset
,
error
)
Poll fetches the latest state of the long-running operation.
Poll also fetches the latest metadata, which can be retrieved by Metadata.
If Poll fails, the error is returned and op is unmodified. If Poll succeeds and the operation has completed with failure, the error is returned and op.Done will return true. If Poll succeeds and the operation has completed successfully, op.Done will return true, and the response of the operation is returned. If Poll succeeds and the operation has not completed, the returned response and error are both nil.
func (*UpdateDatasetOperation) Wait
func
(
op
*
UpdateDatasetOperation
)
Wait
(
ctx
context
.
Context
,
opts
...
gax
.
CallOption
)
(
*
documentaipb
.
Dataset
,
error
)
Wait blocks until the long-running operation is completed, returning the response and any errors encountered.
See documentation of Poll for error-handling information.
