Class: Google::Cloud::DocumentAI::V1beta3::HumanReviewStatus

Inherits:
Object
  • Object
show all
Extended by:
Protobuf::MessageExts::ClassMethods
Includes:
Protobuf::MessageExts
Defined in:
proto_docs/google/cloud/documentai/v1beta3/document_processor_service.rb

Overview

The status of human review on a processed document.

Defined Under Namespace

Modules: State

Instance Attribute Summary collapse

Instance Attribute Details

#human_review_operation ⇒ ::String

Returns The name of the operation triggered by the processed document. This field is populated only when the state is HUMAN_REVIEW_IN_PROGRESS. It has the same response type and metadata as the long-running operation returned by ReviewDocument.

Returns:

  • (::String) —

    The name of the operation triggered by the processed document. This field is populated only when the state is HUMAN_REVIEW_IN_PROGRESS. It has the same response type and metadata as the long-running operation returned by ReviewDocument.



210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
 
# File 'proto_docs/google/cloud/documentai/v1beta3/document_processor_service.rb', line 210

class HumanReviewStatus
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # The final state of human review on a processed document.
  module State
    # Human review state is unspecified. Most likely due to an internal error.
    STATE_UNSPECIFIED = 0

    # Human review is skipped for the document. This can happen because human
    # review isn't enabled on the processor or the processing request has
    # been set to skip this document.
    SKIPPED = 1

    # Human review validation is triggered and passed, so no review is needed.
    VALIDATION_PASSED = 2

    # Human review validation is triggered and the document is under review.
    IN_PROGRESS = 3

    # Some error happened during triggering human review, see the
    # {::Google::Cloud::DocumentAI::V1beta3::HumanReviewStatus#state_message state_message}
    # for details.
    ERROR = 4
  end
end

#state ⇒ ::Google::Cloud::DocumentAI::V1beta3::HumanReviewStatus::State

Returns The state of human review on the processing request.

Returns:



210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
 
# File 'proto_docs/google/cloud/documentai/v1beta3/document_processor_service.rb', line 210

class HumanReviewStatus
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # The final state of human review on a processed document.
  module State
    # Human review state is unspecified. Most likely due to an internal error.
    STATE_UNSPECIFIED = 0

    # Human review is skipped for the document. This can happen because human
    # review isn't enabled on the processor or the processing request has
    # been set to skip this document.
    SKIPPED = 1

    # Human review validation is triggered and passed, so no review is needed.
    VALIDATION_PASSED = 2

    # Human review validation is triggered and the document is under review.
    IN_PROGRESS = 3

    # Some error happened during triggering human review, see the
    # {::Google::Cloud::DocumentAI::V1beta3::HumanReviewStatus#state_message state_message}
    # for details.
    ERROR = 4
  end
end

#state_message ⇒ ::String

Returns A message providing more details about the human review state.

Returns:

  • (::String) —

    A message providing more details about the human review state.



210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
 
# File 'proto_docs/google/cloud/documentai/v1beta3/document_processor_service.rb', line 210

class HumanReviewStatus
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # The final state of human review on a processed document.
  module State
    # Human review state is unspecified. Most likely due to an internal error.
    STATE_UNSPECIFIED = 0

    # Human review is skipped for the document. This can happen because human
    # review isn't enabled on the processor or the processing request has
    # been set to skip this document.
    SKIPPED = 1

    # Human review validation is triggered and passed, so no review is needed.
    VALIDATION_PASSED = 2

    # Human review validation is triggered and the document is under review.
    IN_PROGRESS = 3

    # Some error happened during triggering human review, see the
    # {::Google::Cloud::DocumentAI::V1beta3::HumanReviewStatus#state_message state_message}
    # for details.
    ERROR = 4
  end
end