google-cloud-document_ai-v1beta3 0.8.0 → 0.9.0

Sign up to get free protection for your applications and to get access to all the features.
@@ -500,7 +500,7 @@ module Google
500
500
  #
501
501
  # @!attribute [rw] endpoint
502
502
  # The hostname or hostname:port of the service endpoint.
503
- # Defaults to `"us-documentai.googleapis.com"`.
503
+ # Defaults to `"documentai.googleapis.com"`.
504
504
  # @return [::String]
505
505
  # @!attribute [rw] credentials
506
506
  # Credentials to send with calls. You may provide any of the following types:
@@ -551,7 +551,7 @@ module Google
551
551
  class Configuration
552
552
  extend ::Gapic::Config
553
553
 
554
- config_attr :endpoint, "us-documentai.googleapis.com", ::String
554
+ config_attr :endpoint, "documentai.googleapis.com", ::String
555
555
  config_attr :credentials, nil do |value|
556
556
  allowed = [::String, ::Hash, ::Proc, ::Symbol, ::Google::Auth::Credentials, ::Signet::OAuth2::Client, nil]
557
557
  allowed += [::GRPC::Core::Channel, ::GRPC::Core::ChannelCredentials] if defined? ::GRPC
@@ -43,6 +43,23 @@ module Google
43
43
  "projects/#{project}/locations/#{location}/processors/#{processor}/humanReviewConfig"
44
44
  end
45
45
 
46
+ ##
47
+ # Create a fully-qualified Location resource string.
48
+ #
49
+ # The resource will be in the following format:
50
+ #
51
+ # `projects/{project}/locations/{location}`
52
+ #
53
+ # @param project [String]
54
+ # @param location [String]
55
+ #
56
+ # @return [::String]
57
+ def location_path project:, location:
58
+ raise ::ArgumentError, "project cannot contain /" if project.to_s.include? "/"
59
+
60
+ "projects/#{project}/locations/#{location}"
61
+ end
62
+
46
63
  ##
47
64
  # Create a fully-qualified Processor resource string.
48
65
  #
@@ -21,7 +21,7 @@ module Google
21
21
  module Cloud
22
22
  module DocumentAI
23
23
  module V1beta3
24
- VERSION = "0.8.0"
24
+ VERSION = "0.9.0"
25
25
  end
26
26
  end
27
27
  end
@@ -63,6 +63,7 @@ Google::Protobuf::DescriptorPool.generated_pool.build do
63
63
  repeated :visual_elements, :message, 9, "google.cloud.documentai.v1beta3.Document.Page.VisualElement"
64
64
  repeated :tables, :message, 10, "google.cloud.documentai.v1beta3.Document.Page.Table"
65
65
  repeated :form_fields, :message, 11, "google.cloud.documentai.v1beta3.Document.Page.FormField"
66
+ optional :provenance, :message, 16, "google.cloud.documentai.v1beta3.Document.Provenance"
66
67
  end
67
68
  add_message "google.cloud.documentai.v1beta3.Document.Page.Dimension" do
68
69
  optional :width, :float, 1
@@ -150,6 +151,7 @@ Google::Protobuf::DescriptorPool.generated_pool.build do
150
151
  repeated :name_detected_languages, :message, 3, "google.cloud.documentai.v1beta3.Document.Page.DetectedLanguage"
151
152
  repeated :value_detected_languages, :message, 4, "google.cloud.documentai.v1beta3.Document.Page.DetectedLanguage"
152
153
  optional :value_type, :string, 5
154
+ optional :provenance, :message, 8, "google.cloud.documentai.v1beta3.Document.Provenance"
153
155
  end
154
156
  add_message "google.cloud.documentai.v1beta3.Document.Page.DetectedLanguage" do
155
157
  optional :language_code, :string, 1
@@ -219,6 +221,7 @@ Google::Protobuf::DescriptorPool.generated_pool.build do
219
221
  end
220
222
  add_message "google.cloud.documentai.v1beta3.Document.Provenance.Parent" do
221
223
  optional :revision, :int32, 1
224
+ optional :index, :int32, 3
222
225
  optional :id, :int32, 2
223
226
  end
224
227
  add_enum "google.cloud.documentai.v1beta3.Document.Provenance.OperationType" do
@@ -9,6 +9,9 @@ require 'google/api/field_behavior_pb'
9
9
  require 'google/api/resource_pb'
10
10
  require 'google/cloud/documentai/v1beta3/document_pb'
11
11
  require 'google/cloud/documentai/v1beta3/document_io_pb'
12
+ require 'google/cloud/documentai/v1beta3/operation_metadata_pb'
13
+ require 'google/cloud/documentai/v1beta3/processor_pb'
14
+ require 'google/cloud/documentai/v1beta3/processor_type_pb'
12
15
  require 'google/longrunning/operations_pb'
13
16
  require 'google/protobuf/field_mask_pb'
14
17
  require 'google/protobuf/timestamp_pb'
@@ -81,13 +84,60 @@ Google::Protobuf::DescriptorPool.generated_pool.build do
81
84
  value :CANCELLED, 5
82
85
  value :FAILED, 6
83
86
  end
87
+ add_message "google.cloud.documentai.v1beta3.FetchProcessorTypesRequest" do
88
+ optional :parent, :string, 1
89
+ end
90
+ add_message "google.cloud.documentai.v1beta3.FetchProcessorTypesResponse" do
91
+ repeated :processor_types, :message, 1, "google.cloud.documentai.v1beta3.ProcessorType"
92
+ end
93
+ add_message "google.cloud.documentai.v1beta3.ListProcessorsRequest" do
94
+ optional :parent, :string, 1
95
+ optional :page_size, :int32, 2
96
+ optional :page_token, :string, 3
97
+ end
98
+ add_message "google.cloud.documentai.v1beta3.ListProcessorsResponse" do
99
+ repeated :processors, :message, 1, "google.cloud.documentai.v1beta3.Processor"
100
+ optional :next_page_token, :string, 2
101
+ end
102
+ add_message "google.cloud.documentai.v1beta3.CreateProcessorRequest" do
103
+ optional :parent, :string, 1
104
+ optional :processor, :message, 2, "google.cloud.documentai.v1beta3.Processor"
105
+ end
106
+ add_message "google.cloud.documentai.v1beta3.DeleteProcessorRequest" do
107
+ optional :name, :string, 1
108
+ end
109
+ add_message "google.cloud.documentai.v1beta3.DeleteProcessorMetadata" do
110
+ optional :common_metadata, :message, 5, "google.cloud.documentai.v1beta3.CommonOperationMetadata"
111
+ end
112
+ add_message "google.cloud.documentai.v1beta3.EnableProcessorRequest" do
113
+ optional :name, :string, 1
114
+ end
115
+ add_message "google.cloud.documentai.v1beta3.EnableProcessorResponse" do
116
+ end
117
+ add_message "google.cloud.documentai.v1beta3.EnableProcessorMetadata" do
118
+ optional :common_metadata, :message, 5, "google.cloud.documentai.v1beta3.CommonOperationMetadata"
119
+ end
120
+ add_message "google.cloud.documentai.v1beta3.DisableProcessorRequest" do
121
+ optional :name, :string, 1
122
+ end
123
+ add_message "google.cloud.documentai.v1beta3.DisableProcessorResponse" do
124
+ end
125
+ add_message "google.cloud.documentai.v1beta3.DisableProcessorMetadata" do
126
+ optional :common_metadata, :message, 5, "google.cloud.documentai.v1beta3.CommonOperationMetadata"
127
+ end
84
128
  add_message "google.cloud.documentai.v1beta3.ReviewDocumentRequest" do
85
129
  optional :human_review_config, :string, 1
86
130
  optional :document, :message, 2, "google.cloud.documentai.v1beta3.Document"
131
+ optional :enable_schema_validation, :bool, 3
132
+ optional :priority, :enum, 5, "google.cloud.documentai.v1beta3.ReviewDocumentRequest.Priority"
87
133
  oneof :source do
88
134
  optional :inline_document, :message, 4, "google.cloud.documentai.v1beta3.Document"
89
135
  end
90
136
  end
137
+ add_enum "google.cloud.documentai.v1beta3.ReviewDocumentRequest.Priority" do
138
+ value :DEFAULT, 0
139
+ value :URGENT, 1
140
+ end
91
141
  add_message "google.cloud.documentai.v1beta3.ReviewDocumentResponse" do
92
142
  optional :gcs_destination, :string, 1
93
143
  end
@@ -106,20 +156,6 @@ Google::Protobuf::DescriptorPool.generated_pool.build do
106
156
  value :FAILED, 4
107
157
  value :CANCELLED, 5
108
158
  end
109
- add_message "google.cloud.documentai.v1beta3.CommonOperationMetadata" do
110
- optional :state, :enum, 1, "google.cloud.documentai.v1beta3.CommonOperationMetadata.State"
111
- optional :state_message, :string, 2
112
- optional :create_time, :message, 3, "google.protobuf.Timestamp"
113
- optional :update_time, :message, 4, "google.protobuf.Timestamp"
114
- end
115
- add_enum "google.cloud.documentai.v1beta3.CommonOperationMetadata.State" do
116
- value :STATE_UNSPECIFIED, 0
117
- value :RUNNING, 1
118
- value :CANCELLING, 2
119
- value :SUCCEEDED, 3
120
- value :FAILED, 4
121
- value :CANCELLED, 5
122
- end
123
159
  end
124
160
  end
125
161
 
@@ -138,12 +174,24 @@ module Google
138
174
  BatchProcessMetadata = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.cloud.documentai.v1beta3.BatchProcessMetadata").msgclass
139
175
  BatchProcessMetadata::IndividualProcessStatus = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.cloud.documentai.v1beta3.BatchProcessMetadata.IndividualProcessStatus").msgclass
140
176
  BatchProcessMetadata::State = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.cloud.documentai.v1beta3.BatchProcessMetadata.State").enummodule
177
+ FetchProcessorTypesRequest = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.cloud.documentai.v1beta3.FetchProcessorTypesRequest").msgclass
178
+ FetchProcessorTypesResponse = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.cloud.documentai.v1beta3.FetchProcessorTypesResponse").msgclass
179
+ ListProcessorsRequest = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.cloud.documentai.v1beta3.ListProcessorsRequest").msgclass
180
+ ListProcessorsResponse = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.cloud.documentai.v1beta3.ListProcessorsResponse").msgclass
181
+ CreateProcessorRequest = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.cloud.documentai.v1beta3.CreateProcessorRequest").msgclass
182
+ DeleteProcessorRequest = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.cloud.documentai.v1beta3.DeleteProcessorRequest").msgclass
183
+ DeleteProcessorMetadata = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.cloud.documentai.v1beta3.DeleteProcessorMetadata").msgclass
184
+ EnableProcessorRequest = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.cloud.documentai.v1beta3.EnableProcessorRequest").msgclass
185
+ EnableProcessorResponse = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.cloud.documentai.v1beta3.EnableProcessorResponse").msgclass
186
+ EnableProcessorMetadata = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.cloud.documentai.v1beta3.EnableProcessorMetadata").msgclass
187
+ DisableProcessorRequest = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.cloud.documentai.v1beta3.DisableProcessorRequest").msgclass
188
+ DisableProcessorResponse = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.cloud.documentai.v1beta3.DisableProcessorResponse").msgclass
189
+ DisableProcessorMetadata = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.cloud.documentai.v1beta3.DisableProcessorMetadata").msgclass
141
190
  ReviewDocumentRequest = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.cloud.documentai.v1beta3.ReviewDocumentRequest").msgclass
191
+ ReviewDocumentRequest::Priority = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.cloud.documentai.v1beta3.ReviewDocumentRequest.Priority").enummodule
142
192
  ReviewDocumentResponse = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.cloud.documentai.v1beta3.ReviewDocumentResponse").msgclass
143
193
  ReviewDocumentOperationMetadata = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.cloud.documentai.v1beta3.ReviewDocumentOperationMetadata").msgclass
144
194
  ReviewDocumentOperationMetadata::State = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.cloud.documentai.v1beta3.ReviewDocumentOperationMetadata.State").enummodule
145
- CommonOperationMetadata = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.cloud.documentai.v1beta3.CommonOperationMetadata").msgclass
146
- CommonOperationMetadata::State = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.cloud.documentai.v1beta3.CommonOperationMetadata.State").enummodule
147
195
  end
148
196
  end
149
197
  end
@@ -30,7 +30,7 @@ module Google
30
30
  # structured information from unstructured or semi-structured documents.
31
31
  class Service
32
32
 
33
- include GRPC::GenericService
33
+ include ::GRPC::GenericService
34
34
 
35
35
  self.marshal_class_method = :encode
36
36
  self.unmarshal_class_method = :decode
@@ -41,6 +41,20 @@ module Google
41
41
  # LRO endpoint to batch process many documents. The output is written
42
42
  # to Cloud Storage as JSON in the [Document] format.
43
43
  rpc :BatchProcessDocuments, ::Google::Cloud::DocumentAI::V1beta3::BatchProcessRequest, ::Google::Longrunning::Operation
44
+ # Fetches processor types.
45
+ rpc :FetchProcessorTypes, ::Google::Cloud::DocumentAI::V1beta3::FetchProcessorTypesRequest, ::Google::Cloud::DocumentAI::V1beta3::FetchProcessorTypesResponse
46
+ # Lists all processors which belong to this project.
47
+ rpc :ListProcessors, ::Google::Cloud::DocumentAI::V1beta3::ListProcessorsRequest, ::Google::Cloud::DocumentAI::V1beta3::ListProcessorsResponse
48
+ # Creates a processor from the type processor that the user chose.
49
+ # The processor will be at "ENABLED" state by default after its creation.
50
+ rpc :CreateProcessor, ::Google::Cloud::DocumentAI::V1beta3::CreateProcessorRequest, ::Google::Cloud::DocumentAI::V1beta3::Processor
51
+ # Deletes the processor, unloads all deployed model artifacts if it was
52
+ # enabled and then deletes all artifacts associated with this processor.
53
+ rpc :DeleteProcessor, ::Google::Cloud::DocumentAI::V1beta3::DeleteProcessorRequest, ::Google::Longrunning::Operation
54
+ # Enables a processor
55
+ rpc :EnableProcessor, ::Google::Cloud::DocumentAI::V1beta3::EnableProcessorRequest, ::Google::Longrunning::Operation
56
+ # Disables a processor
57
+ rpc :DisableProcessor, ::Google::Cloud::DocumentAI::V1beta3::DisableProcessorRequest, ::Google::Longrunning::Operation
44
58
  # Send a document for Human Review. The input document should be processed by
45
59
  # the specified processor.
46
60
  rpc :ReviewDocument, ::Google::Cloud::DocumentAI::V1beta3::ReviewDocumentRequest, ::Google::Longrunning::Operation
@@ -0,0 +1,36 @@
1
+ # Generated by the protocol buffer compiler. DO NOT EDIT!
2
+ # source: google/cloud/documentai/v1beta3/operation_metadata.proto
3
+
4
+ require 'google/protobuf'
5
+
6
+ require 'google/protobuf/timestamp_pb'
7
+ require 'google/api/annotations_pb'
8
+ Google::Protobuf::DescriptorPool.generated_pool.build do
9
+ add_file("google/cloud/documentai/v1beta3/operation_metadata.proto", :syntax => :proto3) do
10
+ add_message "google.cloud.documentai.v1beta3.CommonOperationMetadata" do
11
+ optional :state, :enum, 1, "google.cloud.documentai.v1beta3.CommonOperationMetadata.State"
12
+ optional :state_message, :string, 2
13
+ optional :create_time, :message, 3, "google.protobuf.Timestamp"
14
+ optional :update_time, :message, 4, "google.protobuf.Timestamp"
15
+ end
16
+ add_enum "google.cloud.documentai.v1beta3.CommonOperationMetadata.State" do
17
+ value :STATE_UNSPECIFIED, 0
18
+ value :RUNNING, 1
19
+ value :CANCELLING, 2
20
+ value :SUCCEEDED, 3
21
+ value :FAILED, 4
22
+ value :CANCELLED, 5
23
+ end
24
+ end
25
+ end
26
+
27
+ module Google
28
+ module Cloud
29
+ module DocumentAI
30
+ module V1beta3
31
+ CommonOperationMetadata = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.cloud.documentai.v1beta3.CommonOperationMetadata").msgclass
32
+ CommonOperationMetadata::State = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.cloud.documentai.v1beta3.CommonOperationMetadata.State").enummodule
33
+ end
34
+ end
35
+ end
36
+ end
@@ -0,0 +1,45 @@
1
+ # Generated by the protocol buffer compiler. DO NOT EDIT!
2
+ # source: google/cloud/documentai/v1beta3/processor.proto
3
+
4
+ require 'google/protobuf'
5
+
6
+ require 'google/api/field_behavior_pb'
7
+ require 'google/api/resource_pb'
8
+ require 'google/cloud/documentai/v1beta3/document_io_pb'
9
+ require 'google/protobuf/timestamp_pb'
10
+ require 'google/api/annotations_pb'
11
+ Google::Protobuf::DescriptorPool.generated_pool.build do
12
+ add_file("google/cloud/documentai/v1beta3/processor.proto", :syntax => :proto3) do
13
+ add_message "google.cloud.documentai.v1beta3.Processor" do
14
+ optional :name, :string, 1
15
+ optional :type, :string, 2
16
+ optional :display_name, :string, 3
17
+ optional :state, :enum, 4, "google.cloud.documentai.v1beta3.Processor.State"
18
+ optional :default_processor_version, :string, 9
19
+ optional :process_endpoint, :string, 6
20
+ optional :create_time, :message, 7, "google.protobuf.Timestamp"
21
+ optional :kms_key_name, :string, 8
22
+ end
23
+ add_enum "google.cloud.documentai.v1beta3.Processor.State" do
24
+ value :STATE_UNSPECIFIED, 0
25
+ value :ENABLED, 1
26
+ value :DISABLED, 2
27
+ value :ENABLING, 3
28
+ value :DISABLING, 4
29
+ value :CREATING, 5
30
+ value :FAILED, 6
31
+ value :DELETING, 7
32
+ end
33
+ end
34
+ end
35
+
36
+ module Google
37
+ module Cloud
38
+ module DocumentAI
39
+ module V1beta3
40
+ Processor = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.cloud.documentai.v1beta3.Processor").msgclass
41
+ Processor::State = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.cloud.documentai.v1beta3.Processor.State").enummodule
42
+ end
43
+ end
44
+ end
45
+ end
@@ -0,0 +1,32 @@
1
+ # Generated by the protocol buffer compiler. DO NOT EDIT!
2
+ # source: google/cloud/documentai/v1beta3/processor_type.proto
3
+
4
+ require 'google/protobuf'
5
+
6
+ require 'google/api/resource_pb'
7
+ require 'google/api/annotations_pb'
8
+ Google::Protobuf::DescriptorPool.generated_pool.build do
9
+ add_file("google/cloud/documentai/v1beta3/processor_type.proto", :syntax => :proto3) do
10
+ add_message "google.cloud.documentai.v1beta3.ProcessorType" do
11
+ optional :name, :string, 1
12
+ optional :type, :string, 2
13
+ optional :category, :string, 3
14
+ repeated :available_locations, :message, 4, "google.cloud.documentai.v1beta3.ProcessorType.LocationInfo"
15
+ optional :allow_creation, :bool, 6
16
+ end
17
+ add_message "google.cloud.documentai.v1beta3.ProcessorType.LocationInfo" do
18
+ optional :location_id, :string, 1
19
+ end
20
+ end
21
+ end
22
+
23
+ module Google
24
+ module Cloud
25
+ module DocumentAI
26
+ module V1beta3
27
+ ProcessorType = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.cloud.documentai.v1beta3.ProcessorType").msgclass
28
+ ProcessorType::LocationInfo = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.cloud.documentai.v1beta3.ProcessorType.LocationInfo").msgclass
29
+ end
30
+ end
31
+ end
32
+ end
@@ -190,6 +190,9 @@ module Google
190
190
  # @!attribute [rw] form_fields
191
191
  # @return [::Array<::Google::Cloud::DocumentAI::V1beta3::Document::Page::FormField>]
192
192
  # A list of visually detected form fields on the page.
193
+ # @!attribute [rw] provenance
194
+ # @return [::Google::Cloud::DocumentAI::V1beta3::Document::Provenance]
195
+ # The history of this page.
193
196
  class Page
194
197
  include ::Google::Protobuf::MessageExts
195
198
  extend ::Google::Protobuf::MessageExts::ClassMethods
@@ -461,6 +464,9 @@ module Google
461
464
  # - blank (this indicates the field_value is normal text)
462
465
  # - "unfilled_checkbox"
463
466
  # - "filled_checkbox"
467
+ # @!attribute [rw] provenance
468
+ # @return [::Google::Cloud::DocumentAI::V1beta3::Document::Provenance]
469
+ # The history of this annotation.
464
470
  class FormField
465
471
  include ::Google::Protobuf::MessageExts
466
472
  extend ::Google::Protobuf::MessageExts::ClassMethods
@@ -621,6 +627,8 @@ module Google
621
627
  # @return [::Integer]
622
628
  # Required. Index into the {::Google::Cloud::DocumentAI::V1beta3::Document#pages Document.pages} element, for example using
623
629
  # [Document.pages][page_refs.page] to locate the related page element.
630
+ # This field is skipped when its value is the default 0. See
631
+ # https://developers.google.com/protocol-buffers/docs/proto3#json.
624
632
  # @!attribute [rw] layout_type
625
633
  # @return [::Google::Cloud::DocumentAI::V1beta3::Document::PageAnchor::PageRef::LayoutType]
626
634
  # Optional. The type of the layout element that is being referenced if any.
@@ -691,6 +699,10 @@ module Google
691
699
  # @!attribute [rw] revision
692
700
  # @return [::Integer]
693
701
  # The index of the [Document.revisions] identifying the parent revision.
702
+ # @!attribute [rw] index
703
+ # @return [::Integer]
704
+ # The index of the parent revisions corresponding collection of items
705
+ # (eg. list of entities, properties within entities, etc.)
694
706
  # @!attribute [rw] id
695
707
  # @return [::Integer]
696
708
  # The id of the parent provenance.
@@ -229,7 +229,140 @@ module Google
229
229
  end
230
230
  end
231
231
 
232
+ # Request message for fetch processor types.
233
+ # @!attribute [rw] parent
234
+ # @return [::String]
235
+ # Required. The project of processor type to list.
236
+ # Format: projects/\\{project}/locations/\\{location}
237
+ class FetchProcessorTypesRequest
238
+ include ::Google::Protobuf::MessageExts
239
+ extend ::Google::Protobuf::MessageExts::ClassMethods
240
+ end
241
+
242
+ # Response message for fetch processor types.
243
+ # @!attribute [rw] processor_types
244
+ # @return [::Array<::Google::Cloud::DocumentAI::V1beta3::ProcessorType>]
245
+ # The list of processor types.
246
+ class FetchProcessorTypesResponse
247
+ include ::Google::Protobuf::MessageExts
248
+ extend ::Google::Protobuf::MessageExts::ClassMethods
249
+ end
250
+
251
+ # Request message for list all processors belongs to a project.
252
+ # @!attribute [rw] parent
253
+ # @return [::String]
254
+ # Required. The parent (project and location) which owns this collection of Processors.
255
+ # Format: projects/\\{project}/locations/\\{location}
256
+ # @!attribute [rw] page_size
257
+ # @return [::Integer]
258
+ # The maximum number of processors to return.
259
+ # If unspecified, at most 50 processors will be returned.
260
+ # The maximum value is 100; values above 100 will be coerced to 100.
261
+ # @!attribute [rw] page_token
262
+ # @return [::String]
263
+ # We will return the processors sorted by creation time. The page token
264
+ # will point to the next processor.
265
+ class ListProcessorsRequest
266
+ include ::Google::Protobuf::MessageExts
267
+ extend ::Google::Protobuf::MessageExts::ClassMethods
268
+ end
269
+
270
+ # Response message for list processors.
271
+ # @!attribute [rw] processors
272
+ # @return [::Array<::Google::Cloud::DocumentAI::V1beta3::Processor>]
273
+ # The list of processors.
274
+ # @!attribute [rw] next_page_token
275
+ # @return [::String]
276
+ # Points to the next processor, otherwise empty.
277
+ class ListProcessorsResponse
278
+ include ::Google::Protobuf::MessageExts
279
+ extend ::Google::Protobuf::MessageExts::ClassMethods
280
+ end
281
+
282
+ # Request message for create a processor. Notice this request is sent to
283
+ # a regionalized backend service, and if the processor type is not available
284
+ # on that region, the creation will fail.
285
+ # @!attribute [rw] parent
286
+ # @return [::String]
287
+ # Required. The parent (project and location) under which to create the processor.
288
+ # Format: projects/\\{project}/locations/\\{location}
289
+ # @!attribute [rw] processor
290
+ # @return [::Google::Cloud::DocumentAI::V1beta3::Processor]
291
+ # Required. The processor to be created, requires [processor_type] and [display_name]
292
+ # to be set. Also, the processor is under CMEK if CMEK fields are set.
293
+ class CreateProcessorRequest
294
+ include ::Google::Protobuf::MessageExts
295
+ extend ::Google::Protobuf::MessageExts::ClassMethods
296
+ end
297
+
298
+ # Request message for the delete processor method.
299
+ # @!attribute [rw] name
300
+ # @return [::String]
301
+ # Required. The processor resource name to be deleted.
302
+ class DeleteProcessorRequest
303
+ include ::Google::Protobuf::MessageExts
304
+ extend ::Google::Protobuf::MessageExts::ClassMethods
305
+ end
306
+
307
+ # The long running operation metadata for delete processor method.
308
+ # @!attribute [rw] common_metadata
309
+ # @return [::Google::Cloud::DocumentAI::V1beta3::CommonOperationMetadata]
310
+ # The basic metadata of the long running operation.
311
+ class DeleteProcessorMetadata
312
+ include ::Google::Protobuf::MessageExts
313
+ extend ::Google::Protobuf::MessageExts::ClassMethods
314
+ end
315
+
316
+ # Request message for the enable processor method.
317
+ # @!attribute [rw] name
318
+ # @return [::String]
319
+ # Required. The processor resource name to be enabled.
320
+ class EnableProcessorRequest
321
+ include ::Google::Protobuf::MessageExts
322
+ extend ::Google::Protobuf::MessageExts::ClassMethods
323
+ end
324
+
325
+ # Response message for the enable processor method.
326
+ class EnableProcessorResponse
327
+ include ::Google::Protobuf::MessageExts
328
+ extend ::Google::Protobuf::MessageExts::ClassMethods
329
+ end
330
+
331
+ # The long running operation metadata for enable processor method.
332
+ # @!attribute [rw] common_metadata
333
+ # @return [::Google::Cloud::DocumentAI::V1beta3::CommonOperationMetadata]
334
+ # The basic metadata of the long running operation.
335
+ class EnableProcessorMetadata
336
+ include ::Google::Protobuf::MessageExts
337
+ extend ::Google::Protobuf::MessageExts::ClassMethods
338
+ end
339
+
340
+ # Request message for the disable processor method.
341
+ # @!attribute [rw] name
342
+ # @return [::String]
343
+ # Required. The processor resource name to be disabled.
344
+ class DisableProcessorRequest
345
+ include ::Google::Protobuf::MessageExts
346
+ extend ::Google::Protobuf::MessageExts::ClassMethods
347
+ end
348
+
349
+ # Response message for the disable processor method.
350
+ class DisableProcessorResponse
351
+ include ::Google::Protobuf::MessageExts
352
+ extend ::Google::Protobuf::MessageExts::ClassMethods
353
+ end
354
+
355
+ # The long running operation metadata for disable processor method.
356
+ # @!attribute [rw] common_metadata
357
+ # @return [::Google::Cloud::DocumentAI::V1beta3::CommonOperationMetadata]
358
+ # The basic metadata of the long running operation.
359
+ class DisableProcessorMetadata
360
+ include ::Google::Protobuf::MessageExts
361
+ extend ::Google::Protobuf::MessageExts::ClassMethods
362
+ end
363
+
232
364
  # Request message for review document method.
365
+ # Next Id: 6.
233
366
  # @!attribute [rw] inline_document
234
367
  # @return [::Google::Cloud::DocumentAI::V1beta3::Document]
235
368
  # An inline document proto.
@@ -240,9 +373,25 @@ module Google
240
373
  # @!attribute [rw] document
241
374
  # @return [::Google::Cloud::DocumentAI::V1beta3::Document]
242
375
  # The document that needs human review.
376
+ # @!attribute [rw] enable_schema_validation
377
+ # @return [::Boolean]
378
+ # Whether the validation should be performed on the ad-hoc review request.
379
+ # @!attribute [rw] priority
380
+ # @return [::Google::Cloud::DocumentAI::V1beta3::ReviewDocumentRequest::Priority]
381
+ # The priority of the human review task.
243
382
  class ReviewDocumentRequest
244
383
  include ::Google::Protobuf::MessageExts
245
384
  extend ::Google::Protobuf::MessageExts::ClassMethods
385
+
386
+ # The priority level of the human review task.
387
+ module Priority
388
+ # The default priority level.
389
+ DEFAULT = 0
390
+
391
+ # The urgent priority level. The labeling manager should allocate labeler
392
+ # resource to the urgent task queue to respect this priority level.
393
+ URGENT = 1
394
+ end
246
395
  end
247
396
 
248
397
  # Response message for review document method.
@@ -296,45 +445,6 @@ module Google
296
445
  CANCELLED = 5
297
446
  end
298
447
  end
299
-
300
- # The common metadata for long running operations.
301
- # @!attribute [rw] state
302
- # @return [::Google::Cloud::DocumentAI::V1beta3::CommonOperationMetadata::State]
303
- # The state of the operation.
304
- # @!attribute [rw] state_message
305
- # @return [::String]
306
- # A message providing more details about the current state of processing.
307
- # @!attribute [rw] create_time
308
- # @return [::Google::Protobuf::Timestamp]
309
- # The creation time of the operation.
310
- # @!attribute [rw] update_time
311
- # @return [::Google::Protobuf::Timestamp]
312
- # The last update time of the operation.
313
- class CommonOperationMetadata
314
- include ::Google::Protobuf::MessageExts
315
- extend ::Google::Protobuf::MessageExts::ClassMethods
316
-
317
- # State of the longrunning operation.
318
- module State
319
- # Unspecified state.
320
- STATE_UNSPECIFIED = 0
321
-
322
- # Operation is still running.
323
- RUNNING = 1
324
-
325
- # Operation is being cancelled.
326
- CANCELLING = 2
327
-
328
- # Operation succeeded.
329
- SUCCEEDED = 3
330
-
331
- # Operation failed.
332
- FAILED = 4
333
-
334
- # Operation is cancelled.
335
- CANCELLED = 5
336
- end
337
- end
338
448
  end
339
449
  end
340
450
  end