Class: Google::Cloud::DocumentAI::V1::ProcessorVersion

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

Overview

A processor version is an implementation of a processor. Each processor can have multiple versions, pretrained by Google internally or uptrained by the customer. A processor can only have one default version at a time. Its document-processing behavior is defined by that version.

Defined Under Namespace

Modules: ModelType, State Classes: DeprecationInfo, GenAiModelInfo

Instance Attribute Summary collapse

Instance Attribute Details

#create_time ⇒ ::Google::Protobuf::Timestamp

Returns The time the processor version was created.

Returns:



73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
 
# File 'proto_docs/google/cloud/documentai/v1/processor.rb', line 73

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

  # Information about the upcoming deprecation of this processor version.
  # @!attribute [rw] deprecation_time
  #   @return [::Google::Protobuf::Timestamp]
  #     The time at which this processor version will be deprecated.
  # @!attribute [rw] replacement_processor_version
  #   @return [::String]
  #     If set, the processor version that will be used as a replacement.
  class DeprecationInfo
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Information about Generative AI model-based processor versions.
  # @!attribute [rw] foundation_gen_ai_model_info
  #   @return [::Google::Cloud::DocumentAI::V1::ProcessorVersion::GenAiModelInfo::FoundationGenAiModelInfo]
  #     Information for a pretrained Google-managed foundation model.
  # @!attribute [rw] custom_gen_ai_model_info
  #   @return [::Google::Cloud::DocumentAI::V1::ProcessorVersion::GenAiModelInfo::CustomGenAiModelInfo]
  #     Information for a custom Generative AI model created by the user.
  class GenAiModelInfo
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods

    # Information for a pretrained Google-managed foundation model.
    # @!attribute [rw] finetuning_allowed
    #   @return [::Boolean]
    #     Whether finetuning is allowed for this base processor version.
    # @!attribute [rw] min_train_labeled_documents
    #   @return [::Integer]
    #     The minimum number of labeled documents in the training dataset
    #     required for finetuning.
    class FoundationGenAiModelInfo
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods
    end

    # Information for a custom Generative AI model created by the user. These
    # are created with `Create New Version` in either the `Call foundation
    # model` or `Fine tuning` tabs.
    # @!attribute [rw] custom_model_type
    #   @return [::Google::Cloud::DocumentAI::V1::ProcessorVersion::GenAiModelInfo::CustomGenAiModelInfo::CustomModelType]
    #     The type of custom model created by the user.
    # @!attribute [rw] base_processor_version_id
    #   @return [::String]
    #     The base processor version ID for the custom model.
    class CustomGenAiModelInfo
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods

      # The type of custom model created by the user.
      module CustomModelType
        # The model type is unspecified.
        CUSTOM_MODEL_TYPE_UNSPECIFIED = 0

        # The model is a versioned foundation model.
        VERSIONED_FOUNDATION = 1

        # The model is a finetuned foundation model.
        FINE_TUNED = 2
      end
    end
  end

  # The possible states of the processor version.
  module State
    # The processor version is in an unspecified state.
    STATE_UNSPECIFIED = 0

    # The processor version is deployed and can be used for processing.
    DEPLOYED = 1

    # The processor version is being deployed.
    DEPLOYING = 2

    # The processor version is not deployed and cannot be used for processing.
    UNDEPLOYED = 3

    # The processor version is being undeployed.
    UNDEPLOYING = 4

    # The processor version is being created.
    CREATING = 5

    # The processor version is being deleted.
    DELETING = 6

    # The processor version failed and is in an indeterminate state.
    FAILED = 7

    # The processor version is being imported.
    IMPORTING = 8
  end

  # The possible model types of the processor version.
  module ModelType
    # The processor version has unspecified model type.
    MODEL_TYPE_UNSPECIFIED = 0

    # The processor version has generative model type.
    MODEL_TYPE_GENERATIVE = 1

    # The processor version has custom model type.
    MODEL_TYPE_CUSTOM = 2
  end
end

#deprecation_info ⇒ ::Google::Cloud::DocumentAI::V1::ProcessorVersion::DeprecationInfo

Returns If set, information about the eventual deprecation of this version.

Returns:



73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
 
# File 'proto_docs/google/cloud/documentai/v1/processor.rb', line 73

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

  # Information about the upcoming deprecation of this processor version.
  # @!attribute [rw] deprecation_time
  #   @return [::Google::Protobuf::Timestamp]
  #     The time at which this processor version will be deprecated.
  # @!attribute [rw] replacement_processor_version
  #   @return [::String]
  #     If set, the processor version that will be used as a replacement.
  class DeprecationInfo
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Information about Generative AI model-based processor versions.
  # @!attribute [rw] foundation_gen_ai_model_info
  #   @return [::Google::Cloud::DocumentAI::V1::ProcessorVersion::GenAiModelInfo::FoundationGenAiModelInfo]
  #     Information for a pretrained Google-managed foundation model.
  # @!attribute [rw] custom_gen_ai_model_info
  #   @return [::Google::Cloud::DocumentAI::V1::ProcessorVersion::GenAiModelInfo::CustomGenAiModelInfo]
  #     Information for a custom Generative AI model created by the user.
  class GenAiModelInfo
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods

    # Information for a pretrained Google-managed foundation model.
    # @!attribute [rw] finetuning_allowed
    #   @return [::Boolean]
    #     Whether finetuning is allowed for this base processor version.
    # @!attribute [rw] min_train_labeled_documents
    #   @return [::Integer]
    #     The minimum number of labeled documents in the training dataset
    #     required for finetuning.
    class FoundationGenAiModelInfo
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods
    end

    # Information for a custom Generative AI model created by the user. These
    # are created with `Create New Version` in either the `Call foundation
    # model` or `Fine tuning` tabs.
    # @!attribute [rw] custom_model_type
    #   @return [::Google::Cloud::DocumentAI::V1::ProcessorVersion::GenAiModelInfo::CustomGenAiModelInfo::CustomModelType]
    #     The type of custom model created by the user.
    # @!attribute [rw] base_processor_version_id
    #   @return [::String]
    #     The base processor version ID for the custom model.
    class CustomGenAiModelInfo
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods

      # The type of custom model created by the user.
      module CustomModelType
        # The model type is unspecified.
        CUSTOM_MODEL_TYPE_UNSPECIFIED = 0

        # The model is a versioned foundation model.
        VERSIONED_FOUNDATION = 1

        # The model is a finetuned foundation model.
        FINE_TUNED = 2
      end
    end
  end

  # The possible states of the processor version.
  module State
    # The processor version is in an unspecified state.
    STATE_UNSPECIFIED = 0

    # The processor version is deployed and can be used for processing.
    DEPLOYED = 1

    # The processor version is being deployed.
    DEPLOYING = 2

    # The processor version is not deployed and cannot be used for processing.
    UNDEPLOYED = 3

    # The processor version is being undeployed.
    UNDEPLOYING = 4

    # The processor version is being created.
    CREATING = 5

    # The processor version is being deleted.
    DELETING = 6

    # The processor version failed and is in an indeterminate state.
    FAILED = 7

    # The processor version is being imported.
    IMPORTING = 8
  end

  # The possible model types of the processor version.
  module ModelType
    # The processor version has unspecified model type.
    MODEL_TYPE_UNSPECIFIED = 0

    # The processor version has generative model type.
    MODEL_TYPE_GENERATIVE = 1

    # The processor version has custom model type.
    MODEL_TYPE_CUSTOM = 2
  end
end

#display_name ⇒ ::String

Returns The display name of the processor version.

Returns:

  • (::String) —

    The display name of the processor version.



73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
 
# File 'proto_docs/google/cloud/documentai/v1/processor.rb', line 73

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

  # Information about the upcoming deprecation of this processor version.
  # @!attribute [rw] deprecation_time
  #   @return [::Google::Protobuf::Timestamp]
  #     The time at which this processor version will be deprecated.
  # @!attribute [rw] replacement_processor_version
  #   @return [::String]
  #     If set, the processor version that will be used as a replacement.
  class DeprecationInfo
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Information about Generative AI model-based processor versions.
  # @!attribute [rw] foundation_gen_ai_model_info
  #   @return [::Google::Cloud::DocumentAI::V1::ProcessorVersion::GenAiModelInfo::FoundationGenAiModelInfo]
  #     Information for a pretrained Google-managed foundation model.
  # @!attribute [rw] custom_gen_ai_model_info
  #   @return [::Google::Cloud::DocumentAI::V1::ProcessorVersion::GenAiModelInfo::CustomGenAiModelInfo]
  #     Information for a custom Generative AI model created by the user.
  class GenAiModelInfo
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods

    # Information for a pretrained Google-managed foundation model.
    # @!attribute [rw] finetuning_allowed
    #   @return [::Boolean]
    #     Whether finetuning is allowed for this base processor version.
    # @!attribute [rw] min_train_labeled_documents
    #   @return [::Integer]
    #     The minimum number of labeled documents in the training dataset
    #     required for finetuning.
    class FoundationGenAiModelInfo
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods
    end

    # Information for a custom Generative AI model created by the user. These
    # are created with `Create New Version` in either the `Call foundation
    # model` or `Fine tuning` tabs.
    # @!attribute [rw] custom_model_type
    #   @return [::Google::Cloud::DocumentAI::V1::ProcessorVersion::GenAiModelInfo::CustomGenAiModelInfo::CustomModelType]
    #     The type of custom model created by the user.
    # @!attribute [rw] base_processor_version_id
    #   @return [::String]
    #     The base processor version ID for the custom model.
    class CustomGenAiModelInfo
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods

      # The type of custom model created by the user.
      module CustomModelType
        # The model type is unspecified.
        CUSTOM_MODEL_TYPE_UNSPECIFIED = 0

        # The model is a versioned foundation model.
        VERSIONED_FOUNDATION = 1

        # The model is a finetuned foundation model.
        FINE_TUNED = 2
      end
    end
  end

  # The possible states of the processor version.
  module State
    # The processor version is in an unspecified state.
    STATE_UNSPECIFIED = 0

    # The processor version is deployed and can be used for processing.
    DEPLOYED = 1

    # The processor version is being deployed.
    DEPLOYING = 2

    # The processor version is not deployed and cannot be used for processing.
    UNDEPLOYED = 3

    # The processor version is being undeployed.
    UNDEPLOYING = 4

    # The processor version is being created.
    CREATING = 5

    # The processor version is being deleted.
    DELETING = 6

    # The processor version failed and is in an indeterminate state.
    FAILED = 7

    # The processor version is being imported.
    IMPORTING = 8
  end

  # The possible model types of the processor version.
  module ModelType
    # The processor version has unspecified model type.
    MODEL_TYPE_UNSPECIFIED = 0

    # The processor version has generative model type.
    MODEL_TYPE_GENERATIVE = 1

    # The processor version has custom model type.
    MODEL_TYPE_CUSTOM = 2
  end
end

#document_schema ⇒ ::Google::Cloud::DocumentAI::V1::DocumentSchema

Returns The schema of the processor version. Describes the output.

Returns:



73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
 
# File 'proto_docs/google/cloud/documentai/v1/processor.rb', line 73

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

  # Information about the upcoming deprecation of this processor version.
  # @!attribute [rw] deprecation_time
  #   @return [::Google::Protobuf::Timestamp]
  #     The time at which this processor version will be deprecated.
  # @!attribute [rw] replacement_processor_version
  #   @return [::String]
  #     If set, the processor version that will be used as a replacement.
  class DeprecationInfo
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Information about Generative AI model-based processor versions.
  # @!attribute [rw] foundation_gen_ai_model_info
  #   @return [::Google::Cloud::DocumentAI::V1::ProcessorVersion::GenAiModelInfo::FoundationGenAiModelInfo]
  #     Information for a pretrained Google-managed foundation model.
  # @!attribute [rw] custom_gen_ai_model_info
  #   @return [::Google::Cloud::DocumentAI::V1::ProcessorVersion::GenAiModelInfo::CustomGenAiModelInfo]
  #     Information for a custom Generative AI model created by the user.
  class GenAiModelInfo
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods

    # Information for a pretrained Google-managed foundation model.
    # @!attribute [rw] finetuning_allowed
    #   @return [::Boolean]
    #     Whether finetuning is allowed for this base processor version.
    # @!attribute [rw] min_train_labeled_documents
    #   @return [::Integer]
    #     The minimum number of labeled documents in the training dataset
    #     required for finetuning.
    class FoundationGenAiModelInfo
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods
    end

    # Information for a custom Generative AI model created by the user. These
    # are created with `Create New Version` in either the `Call foundation
    # model` or `Fine tuning` tabs.
    # @!attribute [rw] custom_model_type
    #   @return [::Google::Cloud::DocumentAI::V1::ProcessorVersion::GenAiModelInfo::CustomGenAiModelInfo::CustomModelType]
    #     The type of custom model created by the user.
    # @!attribute [rw] base_processor_version_id
    #   @return [::String]
    #     The base processor version ID for the custom model.
    class CustomGenAiModelInfo
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods

      # The type of custom model created by the user.
      module CustomModelType
        # The model type is unspecified.
        CUSTOM_MODEL_TYPE_UNSPECIFIED = 0

        # The model is a versioned foundation model.
        VERSIONED_FOUNDATION = 1

        # The model is a finetuned foundation model.
        FINE_TUNED = 2
      end
    end
  end

  # The possible states of the processor version.
  module State
    # The processor version is in an unspecified state.
    STATE_UNSPECIFIED = 0

    # The processor version is deployed and can be used for processing.
    DEPLOYED = 1

    # The processor version is being deployed.
    DEPLOYING = 2

    # The processor version is not deployed and cannot be used for processing.
    UNDEPLOYED = 3

    # The processor version is being undeployed.
    UNDEPLOYING = 4

    # The processor version is being created.
    CREATING = 5

    # The processor version is being deleted.
    DELETING = 6

    # The processor version failed and is in an indeterminate state.
    FAILED = 7

    # The processor version is being imported.
    IMPORTING = 8
  end

  # The possible model types of the processor version.
  module ModelType
    # The processor version has unspecified model type.
    MODEL_TYPE_UNSPECIFIED = 0

    # The processor version has generative model type.
    MODEL_TYPE_GENERATIVE = 1

    # The processor version has custom model type.
    MODEL_TYPE_CUSTOM = 2
  end
end

#gen_ai_model_info ⇒ ::Google::Cloud::DocumentAI::V1::ProcessorVersion::GenAiModelInfo (readonly)

Returns Output only. Information about Generative AI model-based processor versions.

Returns:



73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
 
# File 'proto_docs/google/cloud/documentai/v1/processor.rb', line 73

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

  # Information about the upcoming deprecation of this processor version.
  # @!attribute [rw] deprecation_time
  #   @return [::Google::Protobuf::Timestamp]
  #     The time at which this processor version will be deprecated.
  # @!attribute [rw] replacement_processor_version
  #   @return [::String]
  #     If set, the processor version that will be used as a replacement.
  class DeprecationInfo
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Information about Generative AI model-based processor versions.
  # @!attribute [rw] foundation_gen_ai_model_info
  #   @return [::Google::Cloud::DocumentAI::V1::ProcessorVersion::GenAiModelInfo::FoundationGenAiModelInfo]
  #     Information for a pretrained Google-managed foundation model.
  # @!attribute [rw] custom_gen_ai_model_info
  #   @return [::Google::Cloud::DocumentAI::V1::ProcessorVersion::GenAiModelInfo::CustomGenAiModelInfo]
  #     Information for a custom Generative AI model created by the user.
  class GenAiModelInfo
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods

    # Information for a pretrained Google-managed foundation model.
    # @!attribute [rw] finetuning_allowed
    #   @return [::Boolean]
    #     Whether finetuning is allowed for this base processor version.
    # @!attribute [rw] min_train_labeled_documents
    #   @return [::Integer]
    #     The minimum number of labeled documents in the training dataset
    #     required for finetuning.
    class FoundationGenAiModelInfo
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods
    end

    # Information for a custom Generative AI model created by the user. These
    # are created with `Create New Version` in either the `Call foundation
    # model` or `Fine tuning` tabs.
    # @!attribute [rw] custom_model_type
    #   @return [::Google::Cloud::DocumentAI::V1::ProcessorVersion::GenAiModelInfo::CustomGenAiModelInfo::CustomModelType]
    #     The type of custom model created by the user.
    # @!attribute [rw] base_processor_version_id
    #   @return [::String]
    #     The base processor version ID for the custom model.
    class CustomGenAiModelInfo
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods

      # The type of custom model created by the user.
      module CustomModelType
        # The model type is unspecified.
        CUSTOM_MODEL_TYPE_UNSPECIFIED = 0

        # The model is a versioned foundation model.
        VERSIONED_FOUNDATION = 1

        # The model is a finetuned foundation model.
        FINE_TUNED = 2
      end
    end
  end

  # The possible states of the processor version.
  module State
    # The processor version is in an unspecified state.
    STATE_UNSPECIFIED = 0

    # The processor version is deployed and can be used for processing.
    DEPLOYED = 1

    # The processor version is being deployed.
    DEPLOYING = 2

    # The processor version is not deployed and cannot be used for processing.
    UNDEPLOYED = 3

    # The processor version is being undeployed.
    UNDEPLOYING = 4

    # The processor version is being created.
    CREATING = 5

    # The processor version is being deleted.
    DELETING = 6

    # The processor version failed and is in an indeterminate state.
    FAILED = 7

    # The processor version is being imported.
    IMPORTING = 8
  end

  # The possible model types of the processor version.
  module ModelType
    # The processor version has unspecified model type.
    MODEL_TYPE_UNSPECIFIED = 0

    # The processor version has generative model type.
    MODEL_TYPE_GENERATIVE = 1

    # The processor version has custom model type.
    MODEL_TYPE_CUSTOM = 2
  end
end

#google_managed ⇒ ::Boolean (readonly)

Returns Output only. Denotes that this ProcessorVersion is managed by Google.

Returns:

  • (::Boolean) —

    Output only. Denotes that this ProcessorVersion is managed by Google.



73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
 
# File 'proto_docs/google/cloud/documentai/v1/processor.rb', line 73

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

  # Information about the upcoming deprecation of this processor version.
  # @!attribute [rw] deprecation_time
  #   @return [::Google::Protobuf::Timestamp]
  #     The time at which this processor version will be deprecated.
  # @!attribute [rw] replacement_processor_version
  #   @return [::String]
  #     If set, the processor version that will be used as a replacement.
  class DeprecationInfo
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Information about Generative AI model-based processor versions.
  # @!attribute [rw] foundation_gen_ai_model_info
  #   @return [::Google::Cloud::DocumentAI::V1::ProcessorVersion::GenAiModelInfo::FoundationGenAiModelInfo]
  #     Information for a pretrained Google-managed foundation model.
  # @!attribute [rw] custom_gen_ai_model_info
  #   @return [::Google::Cloud::DocumentAI::V1::ProcessorVersion::GenAiModelInfo::CustomGenAiModelInfo]
  #     Information for a custom Generative AI model created by the user.
  class GenAiModelInfo
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods

    # Information for a pretrained Google-managed foundation model.
    # @!attribute [rw] finetuning_allowed
    #   @return [::Boolean]
    #     Whether finetuning is allowed for this base processor version.
    # @!attribute [rw] min_train_labeled_documents
    #   @return [::Integer]
    #     The minimum number of labeled documents in the training dataset
    #     required for finetuning.
    class FoundationGenAiModelInfo
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods
    end

    # Information for a custom Generative AI model created by the user. These
    # are created with `Create New Version` in either the `Call foundation
    # model` or `Fine tuning` tabs.
    # @!attribute [rw] custom_model_type
    #   @return [::Google::Cloud::DocumentAI::V1::ProcessorVersion::GenAiModelInfo::CustomGenAiModelInfo::CustomModelType]
    #     The type of custom model created by the user.
    # @!attribute [rw] base_processor_version_id
    #   @return [::String]
    #     The base processor version ID for the custom model.
    class CustomGenAiModelInfo
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods

      # The type of custom model created by the user.
      module CustomModelType
        # The model type is unspecified.
        CUSTOM_MODEL_TYPE_UNSPECIFIED = 0

        # The model is a versioned foundation model.
        VERSIONED_FOUNDATION = 1

        # The model is a finetuned foundation model.
        FINE_TUNED = 2
      end
    end
  end

  # The possible states of the processor version.
  module State
    # The processor version is in an unspecified state.
    STATE_UNSPECIFIED = 0

    # The processor version is deployed and can be used for processing.
    DEPLOYED = 1

    # The processor version is being deployed.
    DEPLOYING = 2

    # The processor version is not deployed and cannot be used for processing.
    UNDEPLOYED = 3

    # The processor version is being undeployed.
    UNDEPLOYING = 4

    # The processor version is being created.
    CREATING = 5

    # The processor version is being deleted.
    DELETING = 6

    # The processor version failed and is in an indeterminate state.
    FAILED = 7

    # The processor version is being imported.
    IMPORTING = 8
  end

  # The possible model types of the processor version.
  module ModelType
    # The processor version has unspecified model type.
    MODEL_TYPE_UNSPECIFIED = 0

    # The processor version has generative model type.
    MODEL_TYPE_GENERATIVE = 1

    # The processor version has custom model type.
    MODEL_TYPE_CUSTOM = 2
  end
end

#kms_key_name ⇒ ::String

Returns The KMS key name used for encryption.

Returns:

  • (::String) —

    The KMS key name used for encryption.



73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
 
# File 'proto_docs/google/cloud/documentai/v1/processor.rb', line 73

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

  # Information about the upcoming deprecation of this processor version.
  # @!attribute [rw] deprecation_time
  #   @return [::Google::Protobuf::Timestamp]
  #     The time at which this processor version will be deprecated.
  # @!attribute [rw] replacement_processor_version
  #   @return [::String]
  #     If set, the processor version that will be used as a replacement.
  class DeprecationInfo
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Information about Generative AI model-based processor versions.
  # @!attribute [rw] foundation_gen_ai_model_info
  #   @return [::Google::Cloud::DocumentAI::V1::ProcessorVersion::GenAiModelInfo::FoundationGenAiModelInfo]
  #     Information for a pretrained Google-managed foundation model.
  # @!attribute [rw] custom_gen_ai_model_info
  #   @return [::Google::Cloud::DocumentAI::V1::ProcessorVersion::GenAiModelInfo::CustomGenAiModelInfo]
  #     Information for a custom Generative AI model created by the user.
  class GenAiModelInfo
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods

    # Information for a pretrained Google-managed foundation model.
    # @!attribute [rw] finetuning_allowed
    #   @return [::Boolean]
    #     Whether finetuning is allowed for this base processor version.
    # @!attribute [rw] min_train_labeled_documents
    #   @return [::Integer]
    #     The minimum number of labeled documents in the training dataset
    #     required for finetuning.
    class FoundationGenAiModelInfo
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods
    end

    # Information for a custom Generative AI model created by the user. These
    # are created with `Create New Version` in either the `Call foundation
    # model` or `Fine tuning` tabs.
    # @!attribute [rw] custom_model_type
    #   @return [::Google::Cloud::DocumentAI::V1::ProcessorVersion::GenAiModelInfo::CustomGenAiModelInfo::CustomModelType]
    #     The type of custom model created by the user.
    # @!attribute [rw] base_processor_version_id
    #   @return [::String]
    #     The base processor version ID for the custom model.
    class CustomGenAiModelInfo
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods

      # The type of custom model created by the user.
      module CustomModelType
        # The model type is unspecified.
        CUSTOM_MODEL_TYPE_UNSPECIFIED = 0

        # The model is a versioned foundation model.
        VERSIONED_FOUNDATION = 1

        # The model is a finetuned foundation model.
        FINE_TUNED = 2
      end
    end
  end

  # The possible states of the processor version.
  module State
    # The processor version is in an unspecified state.
    STATE_UNSPECIFIED = 0

    # The processor version is deployed and can be used for processing.
    DEPLOYED = 1

    # The processor version is being deployed.
    DEPLOYING = 2

    # The processor version is not deployed and cannot be used for processing.
    UNDEPLOYED = 3

    # The processor version is being undeployed.
    UNDEPLOYING = 4

    # The processor version is being created.
    CREATING = 5

    # The processor version is being deleted.
    DELETING = 6

    # The processor version failed and is in an indeterminate state.
    FAILED = 7

    # The processor version is being imported.
    IMPORTING = 8
  end

  # The possible model types of the processor version.
  module ModelType
    # The processor version has unspecified model type.
    MODEL_TYPE_UNSPECIFIED = 0

    # The processor version has generative model type.
    MODEL_TYPE_GENERATIVE = 1

    # The processor version has custom model type.
    MODEL_TYPE_CUSTOM = 2
  end
end

#kms_key_version_name ⇒ ::String

Returns The KMS key version with which data is encrypted.

Returns:

  • (::String) —

    The KMS key version with which data is encrypted.



73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
 
# File 'proto_docs/google/cloud/documentai/v1/processor.rb', line 73

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

  # Information about the upcoming deprecation of this processor version.
  # @!attribute [rw] deprecation_time
  #   @return [::Google::Protobuf::Timestamp]
  #     The time at which this processor version will be deprecated.
  # @!attribute [rw] replacement_processor_version
  #   @return [::String]
  #     If set, the processor version that will be used as a replacement.
  class DeprecationInfo
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Information about Generative AI model-based processor versions.
  # @!attribute [rw] foundation_gen_ai_model_info
  #   @return [::Google::Cloud::DocumentAI::V1::ProcessorVersion::GenAiModelInfo::FoundationGenAiModelInfo]
  #     Information for a pretrained Google-managed foundation model.
  # @!attribute [rw] custom_gen_ai_model_info
  #   @return [::Google::Cloud::DocumentAI::V1::ProcessorVersion::GenAiModelInfo::CustomGenAiModelInfo]
  #     Information for a custom Generative AI model created by the user.
  class GenAiModelInfo
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods

    # Information for a pretrained Google-managed foundation model.
    # @!attribute [rw] finetuning_allowed
    #   @return [::Boolean]
    #     Whether finetuning is allowed for this base processor version.
    # @!attribute [rw] min_train_labeled_documents
    #   @return [::Integer]
    #     The minimum number of labeled documents in the training dataset
    #     required for finetuning.
    class FoundationGenAiModelInfo
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods
    end

    # Information for a custom Generative AI model created by the user. These
    # are created with `Create New Version` in either the `Call foundation
    # model` or `Fine tuning` tabs.
    # @!attribute [rw] custom_model_type
    #   @return [::Google::Cloud::DocumentAI::V1::ProcessorVersion::GenAiModelInfo::CustomGenAiModelInfo::CustomModelType]
    #     The type of custom model created by the user.
    # @!attribute [rw] base_processor_version_id
    #   @return [::String]
    #     The base processor version ID for the custom model.
    class CustomGenAiModelInfo
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods

      # The type of custom model created by the user.
      module CustomModelType
        # The model type is unspecified.
        CUSTOM_MODEL_TYPE_UNSPECIFIED = 0

        # The model is a versioned foundation model.
        VERSIONED_FOUNDATION = 1

        # The model is a finetuned foundation model.
        FINE_TUNED = 2
      end
    end
  end

  # The possible states of the processor version.
  module State
    # The processor version is in an unspecified state.
    STATE_UNSPECIFIED = 0

    # The processor version is deployed and can be used for processing.
    DEPLOYED = 1

    # The processor version is being deployed.
    DEPLOYING = 2

    # The processor version is not deployed and cannot be used for processing.
    UNDEPLOYED = 3

    # The processor version is being undeployed.
    UNDEPLOYING = 4

    # The processor version is being created.
    CREATING = 5

    # The processor version is being deleted.
    DELETING = 6

    # The processor version failed and is in an indeterminate state.
    FAILED = 7

    # The processor version is being imported.
    IMPORTING = 8
  end

  # The possible model types of the processor version.
  module ModelType
    # The processor version has unspecified model type.
    MODEL_TYPE_UNSPECIFIED = 0

    # The processor version has generative model type.
    MODEL_TYPE_GENERATIVE = 1

    # The processor version has custom model type.
    MODEL_TYPE_CUSTOM = 2
  end
end

#latest_evaluation ⇒ ::Google::Cloud::DocumentAI::V1::EvaluationReference

Returns The most recently invoked evaluation for the processor version.

Returns:



73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
 
# File 'proto_docs/google/cloud/documentai/v1/processor.rb', line 73

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

  # Information about the upcoming deprecation of this processor version.
  # @!attribute [rw] deprecation_time
  #   @return [::Google::Protobuf::Timestamp]
  #     The time at which this processor version will be deprecated.
  # @!attribute [rw] replacement_processor_version
  #   @return [::String]
  #     If set, the processor version that will be used as a replacement.
  class DeprecationInfo
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Information about Generative AI model-based processor versions.
  # @!attribute [rw] foundation_gen_ai_model_info
  #   @return [::Google::Cloud::DocumentAI::V1::ProcessorVersion::GenAiModelInfo::FoundationGenAiModelInfo]
  #     Information for a pretrained Google-managed foundation model.
  # @!attribute [rw] custom_gen_ai_model_info
  #   @return [::Google::Cloud::DocumentAI::V1::ProcessorVersion::GenAiModelInfo::CustomGenAiModelInfo]
  #     Information for a custom Generative AI model created by the user.
  class GenAiModelInfo
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods

    # Information for a pretrained Google-managed foundation model.
    # @!attribute [rw] finetuning_allowed
    #   @return [::Boolean]
    #     Whether finetuning is allowed for this base processor version.
    # @!attribute [rw] min_train_labeled_documents
    #   @return [::Integer]
    #     The minimum number of labeled documents in the training dataset
    #     required for finetuning.
    class FoundationGenAiModelInfo
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods
    end

    # Information for a custom Generative AI model created by the user. These
    # are created with `Create New Version` in either the `Call foundation
    # model` or `Fine tuning` tabs.
    # @!attribute [rw] custom_model_type
    #   @return [::Google::Cloud::DocumentAI::V1::ProcessorVersion::GenAiModelInfo::CustomGenAiModelInfo::CustomModelType]
    #     The type of custom model created by the user.
    # @!attribute [rw] base_processor_version_id
    #   @return [::String]
    #     The base processor version ID for the custom model.
    class CustomGenAiModelInfo
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods

      # The type of custom model created by the user.
      module CustomModelType
        # The model type is unspecified.
        CUSTOM_MODEL_TYPE_UNSPECIFIED = 0

        # The model is a versioned foundation model.
        VERSIONED_FOUNDATION = 1

        # The model is a finetuned foundation model.
        FINE_TUNED = 2
      end
    end
  end

  # The possible states of the processor version.
  module State
    # The processor version is in an unspecified state.
    STATE_UNSPECIFIED = 0

    # The processor version is deployed and can be used for processing.
    DEPLOYED = 1

    # The processor version is being deployed.
    DEPLOYING = 2

    # The processor version is not deployed and cannot be used for processing.
    UNDEPLOYED = 3

    # The processor version is being undeployed.
    UNDEPLOYING = 4

    # The processor version is being created.
    CREATING = 5

    # The processor version is being deleted.
    DELETING = 6

    # The processor version failed and is in an indeterminate state.
    FAILED = 7

    # The processor version is being imported.
    IMPORTING = 8
  end

  # The possible model types of the processor version.
  module ModelType
    # The processor version has unspecified model type.
    MODEL_TYPE_UNSPECIFIED = 0

    # The processor version has generative model type.
    MODEL_TYPE_GENERATIVE = 1

    # The processor version has custom model type.
    MODEL_TYPE_CUSTOM = 2
  end
end

#model_type ⇒ ::Google::Cloud::DocumentAI::V1::ProcessorVersion::ModelType (readonly)

Returns Output only. The model type of this processor version.

Returns:



73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
 
# File 'proto_docs/google/cloud/documentai/v1/processor.rb', line 73

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

  # Information about the upcoming deprecation of this processor version.
  # @!attribute [rw] deprecation_time
  #   @return [::Google::Protobuf::Timestamp]
  #     The time at which this processor version will be deprecated.
  # @!attribute [rw] replacement_processor_version
  #   @return [::String]
  #     If set, the processor version that will be used as a replacement.
  class DeprecationInfo
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Information about Generative AI model-based processor versions.
  # @!attribute [rw] foundation_gen_ai_model_info
  #   @return [::Google::Cloud::DocumentAI::V1::ProcessorVersion::GenAiModelInfo::FoundationGenAiModelInfo]
  #     Information for a pretrained Google-managed foundation model.
  # @!attribute [rw] custom_gen_ai_model_info
  #   @return [::Google::Cloud::DocumentAI::V1::ProcessorVersion::GenAiModelInfo::CustomGenAiModelInfo]
  #     Information for a custom Generative AI model created by the user.
  class GenAiModelInfo
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods

    # Information for a pretrained Google-managed foundation model.
    # @!attribute [rw] finetuning_allowed
    #   @return [::Boolean]
    #     Whether finetuning is allowed for this base processor version.
    # @!attribute [rw] min_train_labeled_documents
    #   @return [::Integer]
    #     The minimum number of labeled documents in the training dataset
    #     required for finetuning.
    class FoundationGenAiModelInfo
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods
    end

    # Information for a custom Generative AI model created by the user. These
    # are created with `Create New Version` in either the `Call foundation
    # model` or `Fine tuning` tabs.
    # @!attribute [rw] custom_model_type
    #   @return [::Google::Cloud::DocumentAI::V1::ProcessorVersion::GenAiModelInfo::CustomGenAiModelInfo::CustomModelType]
    #     The type of custom model created by the user.
    # @!attribute [rw] base_processor_version_id
    #   @return [::String]
    #     The base processor version ID for the custom model.
    class CustomGenAiModelInfo
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods

      # The type of custom model created by the user.
      module CustomModelType
        # The model type is unspecified.
        CUSTOM_MODEL_TYPE_UNSPECIFIED = 0

        # The model is a versioned foundation model.
        VERSIONED_FOUNDATION = 1

        # The model is a finetuned foundation model.
        FINE_TUNED = 2
      end
    end
  end

  # The possible states of the processor version.
  module State
    # The processor version is in an unspecified state.
    STATE_UNSPECIFIED = 0

    # The processor version is deployed and can be used for processing.
    DEPLOYED = 1

    # The processor version is being deployed.
    DEPLOYING = 2

    # The processor version is not deployed and cannot be used for processing.
    UNDEPLOYED = 3

    # The processor version is being undeployed.
    UNDEPLOYING = 4

    # The processor version is being created.
    CREATING = 5

    # The processor version is being deleted.
    DELETING = 6

    # The processor version failed and is in an indeterminate state.
    FAILED = 7

    # The processor version is being imported.
    IMPORTING = 8
  end

  # The possible model types of the processor version.
  module ModelType
    # The processor version has unspecified model type.
    MODEL_TYPE_UNSPECIFIED = 0

    # The processor version has generative model type.
    MODEL_TYPE_GENERATIVE = 1

    # The processor version has custom model type.
    MODEL_TYPE_CUSTOM = 2
  end
end

#name ⇒ ::String

Returns Identifier. The resource name of the processor version. Format: projects/{project}/locations/{location}/processors/{processor}/processorVersions/{processor_version}.

Returns:

  • (::String) —

    Identifier. The resource name of the processor version. Format: projects/{project}/locations/{location}/processors/{processor}/processorVersions/{processor_version}



73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
 
# File 'proto_docs/google/cloud/documentai/v1/processor.rb', line 73

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

  # Information about the upcoming deprecation of this processor version.
  # @!attribute [rw] deprecation_time
  #   @return [::Google::Protobuf::Timestamp]
  #     The time at which this processor version will be deprecated.
  # @!attribute [rw] replacement_processor_version
  #   @return [::String]
  #     If set, the processor version that will be used as a replacement.
  class DeprecationInfo
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Information about Generative AI model-based processor versions.
  # @!attribute [rw] foundation_gen_ai_model_info
  #   @return [::Google::Cloud::DocumentAI::V1::ProcessorVersion::GenAiModelInfo::FoundationGenAiModelInfo]
  #     Information for a pretrained Google-managed foundation model.
  # @!attribute [rw] custom_gen_ai_model_info
  #   @return [::Google::Cloud::DocumentAI::V1::ProcessorVersion::GenAiModelInfo::CustomGenAiModelInfo]
  #     Information for a custom Generative AI model created by the user.
  class GenAiModelInfo
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods

    # Information for a pretrained Google-managed foundation model.
    # @!attribute [rw] finetuning_allowed
    #   @return [::Boolean]
    #     Whether finetuning is allowed for this base processor version.
    # @!attribute [rw] min_train_labeled_documents
    #   @return [::Integer]
    #     The minimum number of labeled documents in the training dataset
    #     required for finetuning.
    class FoundationGenAiModelInfo
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods
    end

    # Information for a custom Generative AI model created by the user. These
    # are created with `Create New Version` in either the `Call foundation
    # model` or `Fine tuning` tabs.
    # @!attribute [rw] custom_model_type
    #   @return [::Google::Cloud::DocumentAI::V1::ProcessorVersion::GenAiModelInfo::CustomGenAiModelInfo::CustomModelType]
    #     The type of custom model created by the user.
    # @!attribute [rw] base_processor_version_id
    #   @return [::String]
    #     The base processor version ID for the custom model.
    class CustomGenAiModelInfo
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods

      # The type of custom model created by the user.
      module CustomModelType
        # The model type is unspecified.
        CUSTOM_MODEL_TYPE_UNSPECIFIED = 0

        # The model is a versioned foundation model.
        VERSIONED_FOUNDATION = 1

        # The model is a finetuned foundation model.
        FINE_TUNED = 2
      end
    end
  end

  # The possible states of the processor version.
  module State
    # The processor version is in an unspecified state.
    STATE_UNSPECIFIED = 0

    # The processor version is deployed and can be used for processing.
    DEPLOYED = 1

    # The processor version is being deployed.
    DEPLOYING = 2

    # The processor version is not deployed and cannot be used for processing.
    UNDEPLOYED = 3

    # The processor version is being undeployed.
    UNDEPLOYING = 4

    # The processor version is being created.
    CREATING = 5

    # The processor version is being deleted.
    DELETING = 6

    # The processor version failed and is in an indeterminate state.
    FAILED = 7

    # The processor version is being imported.
    IMPORTING = 8
  end

  # The possible model types of the processor version.
  module ModelType
    # The processor version has unspecified model type.
    MODEL_TYPE_UNSPECIFIED = 0

    # The processor version has generative model type.
    MODEL_TYPE_GENERATIVE = 1

    # The processor version has custom model type.
    MODEL_TYPE_CUSTOM = 2
  end
end

#satisfies_pzi ⇒ ::Boolean (readonly)

Returns Output only. Reserved for future use.

Returns:

  • (::Boolean) —

    Output only. Reserved for future use.



73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
 
# File 'proto_docs/google/cloud/documentai/v1/processor.rb', line 73

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

  # Information about the upcoming deprecation of this processor version.
  # @!attribute [rw] deprecation_time
  #   @return [::Google::Protobuf::Timestamp]
  #     The time at which this processor version will be deprecated.
  # @!attribute [rw] replacement_processor_version
  #   @return [::String]
  #     If set, the processor version that will be used as a replacement.
  class DeprecationInfo
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Information about Generative AI model-based processor versions.
  # @!attribute [rw] foundation_gen_ai_model_info
  #   @return [::Google::Cloud::DocumentAI::V1::ProcessorVersion::GenAiModelInfo::FoundationGenAiModelInfo]
  #     Information for a pretrained Google-managed foundation model.
  # @!attribute [rw] custom_gen_ai_model_info
  #   @return [::Google::Cloud::DocumentAI::V1::ProcessorVersion::GenAiModelInfo::CustomGenAiModelInfo]
  #     Information for a custom Generative AI model created by the user.
  class GenAiModelInfo
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods

    # Information for a pretrained Google-managed foundation model.
    # @!attribute [rw] finetuning_allowed
    #   @return [::Boolean]
    #     Whether finetuning is allowed for this base processor version.
    # @!attribute [rw] min_train_labeled_documents
    #   @return [::Integer]
    #     The minimum number of labeled documents in the training dataset
    #     required for finetuning.
    class FoundationGenAiModelInfo
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods
    end

    # Information for a custom Generative AI model created by the user. These
    # are created with `Create New Version` in either the `Call foundation
    # model` or `Fine tuning` tabs.
    # @!attribute [rw] custom_model_type
    #   @return [::Google::Cloud::DocumentAI::V1::ProcessorVersion::GenAiModelInfo::CustomGenAiModelInfo::CustomModelType]
    #     The type of custom model created by the user.
    # @!attribute [rw] base_processor_version_id
    #   @return [::String]
    #     The base processor version ID for the custom model.
    class CustomGenAiModelInfo
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods

      # The type of custom model created by the user.
      module CustomModelType
        # The model type is unspecified.
        CUSTOM_MODEL_TYPE_UNSPECIFIED = 0

        # The model is a versioned foundation model.
        VERSIONED_FOUNDATION = 1

        # The model is a finetuned foundation model.
        FINE_TUNED = 2
      end
    end
  end

  # The possible states of the processor version.
  module State
    # The processor version is in an unspecified state.
    STATE_UNSPECIFIED = 0

    # The processor version is deployed and can be used for processing.
    DEPLOYED = 1

    # The processor version is being deployed.
    DEPLOYING = 2

    # The processor version is not deployed and cannot be used for processing.
    UNDEPLOYED = 3

    # The processor version is being undeployed.
    UNDEPLOYING = 4

    # The processor version is being created.
    CREATING = 5

    # The processor version is being deleted.
    DELETING = 6

    # The processor version failed and is in an indeterminate state.
    FAILED = 7

    # The processor version is being imported.
    IMPORTING = 8
  end

  # The possible model types of the processor version.
  module ModelType
    # The processor version has unspecified model type.
    MODEL_TYPE_UNSPECIFIED = 0

    # The processor version has generative model type.
    MODEL_TYPE_GENERATIVE = 1

    # The processor version has custom model type.
    MODEL_TYPE_CUSTOM = 2
  end
end

#satisfies_pzs ⇒ ::Boolean (readonly)

Returns Output only. Reserved for future use.

Returns:

  • (::Boolean) —

    Output only. Reserved for future use.



73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
 
# File 'proto_docs/google/cloud/documentai/v1/processor.rb', line 73

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

  # Information about the upcoming deprecation of this processor version.
  # @!attribute [rw] deprecation_time
  #   @return [::Google::Protobuf::Timestamp]
  #     The time at which this processor version will be deprecated.
  # @!attribute [rw] replacement_processor_version
  #   @return [::String]
  #     If set, the processor version that will be used as a replacement.
  class DeprecationInfo
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Information about Generative AI model-based processor versions.
  # @!attribute [rw] foundation_gen_ai_model_info
  #   @return [::Google::Cloud::DocumentAI::V1::ProcessorVersion::GenAiModelInfo::FoundationGenAiModelInfo]
  #     Information for a pretrained Google-managed foundation model.
  # @!attribute [rw] custom_gen_ai_model_info
  #   @return [::Google::Cloud::DocumentAI::V1::ProcessorVersion::GenAiModelInfo::CustomGenAiModelInfo]
  #     Information for a custom Generative AI model created by the user.
  class GenAiModelInfo
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods

    # Information for a pretrained Google-managed foundation model.
    # @!attribute [rw] finetuning_allowed
    #   @return [::Boolean]
    #     Whether finetuning is allowed for this base processor version.
    # @!attribute [rw] min_train_labeled_documents
    #   @return [::Integer]
    #     The minimum number of labeled documents in the training dataset
    #     required for finetuning.
    class FoundationGenAiModelInfo
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods
    end

    # Information for a custom Generative AI model created by the user. These
    # are created with `Create New Version` in either the `Call foundation
    # model` or `Fine tuning` tabs.
    # @!attribute [rw] custom_model_type
    #   @return [::Google::Cloud::DocumentAI::V1::ProcessorVersion::GenAiModelInfo::CustomGenAiModelInfo::CustomModelType]
    #     The type of custom model created by the user.
    # @!attribute [rw] base_processor_version_id
    #   @return [::String]
    #     The base processor version ID for the custom model.
    class CustomGenAiModelInfo
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods

      # The type of custom model created by the user.
      module CustomModelType
        # The model type is unspecified.
        CUSTOM_MODEL_TYPE_UNSPECIFIED = 0

        # The model is a versioned foundation model.
        VERSIONED_FOUNDATION = 1

        # The model is a finetuned foundation model.
        FINE_TUNED = 2
      end
    end
  end

  # The possible states of the processor version.
  module State
    # The processor version is in an unspecified state.
    STATE_UNSPECIFIED = 0

    # The processor version is deployed and can be used for processing.
    DEPLOYED = 1

    # The processor version is being deployed.
    DEPLOYING = 2

    # The processor version is not deployed and cannot be used for processing.
    UNDEPLOYED = 3

    # The processor version is being undeployed.
    UNDEPLOYING = 4

    # The processor version is being created.
    CREATING = 5

    # The processor version is being deleted.
    DELETING = 6

    # The processor version failed and is in an indeterminate state.
    FAILED = 7

    # The processor version is being imported.
    IMPORTING = 8
  end

  # The possible model types of the processor version.
  module ModelType
    # The processor version has unspecified model type.
    MODEL_TYPE_UNSPECIFIED = 0

    # The processor version has generative model type.
    MODEL_TYPE_GENERATIVE = 1

    # The processor version has custom model type.
    MODEL_TYPE_CUSTOM = 2
  end
end

#state ⇒ ::Google::Cloud::DocumentAI::V1::ProcessorVersion::State (readonly)

Returns Output only. The state of the processor version.

Returns:



73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
 
# File 'proto_docs/google/cloud/documentai/v1/processor.rb', line 73

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

  # Information about the upcoming deprecation of this processor version.
  # @!attribute [rw] deprecation_time
  #   @return [::Google::Protobuf::Timestamp]
  #     The time at which this processor version will be deprecated.
  # @!attribute [rw] replacement_processor_version
  #   @return [::String]
  #     If set, the processor version that will be used as a replacement.
  class DeprecationInfo
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Information about Generative AI model-based processor versions.
  # @!attribute [rw] foundation_gen_ai_model_info
  #   @return [::Google::Cloud::DocumentAI::V1::ProcessorVersion::GenAiModelInfo::FoundationGenAiModelInfo]
  #     Information for a pretrained Google-managed foundation model.
  # @!attribute [rw] custom_gen_ai_model_info
  #   @return [::Google::Cloud::DocumentAI::V1::ProcessorVersion::GenAiModelInfo::CustomGenAiModelInfo]
  #     Information for a custom Generative AI model created by the user.
  class GenAiModelInfo
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods

    # Information for a pretrained Google-managed foundation model.
    # @!attribute [rw] finetuning_allowed
    #   @return [::Boolean]
    #     Whether finetuning is allowed for this base processor version.
    # @!attribute [rw] min_train_labeled_documents
    #   @return [::Integer]
    #     The minimum number of labeled documents in the training dataset
    #     required for finetuning.
    class FoundationGenAiModelInfo
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods
    end

    # Information for a custom Generative AI model created by the user. These
    # are created with `Create New Version` in either the `Call foundation
    # model` or `Fine tuning` tabs.
    # @!attribute [rw] custom_model_type
    #   @return [::Google::Cloud::DocumentAI::V1::ProcessorVersion::GenAiModelInfo::CustomGenAiModelInfo::CustomModelType]
    #     The type of custom model created by the user.
    # @!attribute [rw] base_processor_version_id
    #   @return [::String]
    #     The base processor version ID for the custom model.
    class CustomGenAiModelInfo
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods

      # The type of custom model created by the user.
      module CustomModelType
        # The model type is unspecified.
        CUSTOM_MODEL_TYPE_UNSPECIFIED = 0

        # The model is a versioned foundation model.
        VERSIONED_FOUNDATION = 1

        # The model is a finetuned foundation model.
        FINE_TUNED = 2
      end
    end
  end

  # The possible states of the processor version.
  module State
    # The processor version is in an unspecified state.
    STATE_UNSPECIFIED = 0

    # The processor version is deployed and can be used for processing.
    DEPLOYED = 1

    # The processor version is being deployed.
    DEPLOYING = 2

    # The processor version is not deployed and cannot be used for processing.
    UNDEPLOYED = 3

    # The processor version is being undeployed.
    UNDEPLOYING = 4

    # The processor version is being created.
    CREATING = 5

    # The processor version is being deleted.
    DELETING = 6

    # The processor version failed and is in an indeterminate state.
    FAILED = 7

    # The processor version is being imported.
    IMPORTING = 8
  end

  # The possible model types of the processor version.
  module ModelType
    # The processor version has unspecified model type.
    MODEL_TYPE_UNSPECIFIED = 0

    # The processor version has generative model type.
    MODEL_TYPE_GENERATIVE = 1

    # The processor version has custom model type.
    MODEL_TYPE_CUSTOM = 2
  end
end