ProcessorVersion

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.

JSON representation
{
  "name": string,
  "displayName": string,
  "documentSchema": {
    object (DocumentSchema)
  },
  "state": enum (State),
  "createTime": string,
  "latestEvaluation": {
    object (EvaluationReference)
  },
  "kmsKeyName": string,
  "kmsKeyVersionName": string,
  "googleManaged": boolean,
  "deprecationInfo": {
    object (DeprecationInfo)
  },
  "modelType": enum (ModelType),
  "satisfiesPzs": boolean,
  "satisfiesPzi": boolean,
  "genAiModelInfo": {
    object (GenAiModelInfo)
  }
}
Fields
name

string

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

displayName

string

The display name of the processor version.

documentSchema

object (DocumentSchema)

Output only. The schema of the processor version. Describes the output.

state

enum (State)

Output only. The state of the processor version.

createTime

string (Timestamp format)

Output only. The time the processor version was created.

Uses RFC 3339, where generated output will always be Z-normalized and use 0, 3, 6 or 9 fractional digits. Offsets other than "Z" are also accepted. Examples: "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" or "2014-10-02T15:01:23+05:30".

latestEvaluation

object (EvaluationReference)

Output only. The most recently invoked evaluation for the processor version.

kmsKeyName

string

Output only. The KMS key name used for encryption.

kmsKeyVersionName

string

Output only. The KMS key version with which data is encrypted.

googleManaged

boolean

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

deprecationInfo

object (DeprecationInfo)

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

modelType

enum (ModelType)

Output only. The model type of this processor version.

satisfiesPzs

boolean

Output only. Reserved for future use.

satisfiesPzi

boolean

Output only. Reserved for future use.

genAiModelInfo

object (GenAiModelInfo)

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

DeprecationInfo

Information about the upcoming deprecation of this processor version.

JSON representation
{
  "deprecationTime": string,
  "replacementProcessorVersion": string
}
Fields
deprecationTime

string (Timestamp format)

The time at which this processor version will be deprecated.

Uses RFC 3339, where generated output will always be Z-normalized and use 0, 3, 6 or 9 fractional digits. Offsets other than "Z" are also accepted. Examples: "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" or "2014-10-02T15:01:23+05:30".

replacementProcessorVersion

string

If set, the processor version that will be used as a replacement.

GenAiModelInfo

Information about Generative AI model-based processor versions.

JSON representation
{

  // Union field model_info can be only one of the following:
  "foundationGenAiModelInfo": {
    object (FoundationGenAiModelInfo)
  },
  "customGenAiModelInfo": {
    object (CustomGenAiModelInfo)
  }
  // End of list of possible types for union field model_info.
}
Fields
Union field model_info. The processor version is either a pretrained Google-managed foundation model or a custom Generative AI model created by the user. model_info can be only one of the following:
foundationGenAiModelInfo

object (FoundationGenAiModelInfo)

Information for a pretrained Google-managed foundation model.

customGenAiModelInfo

object (CustomGenAiModelInfo)

Information for a custom Generative AI model created by the user.

FoundationGenAiModelInfo

Information for a pretrained Google-managed foundation model.

JSON representation
{
  "finetuningAllowed": boolean,
  "minTrainLabeledDocuments": integer
}
Fields
finetuningAllowed

boolean

Whether fine tuning is allowed for this base processor version.

minTrainLabeledDocuments

integer

The minimum number of labeled documents in the training dataset required for fine tuning.

CustomGenAiModelInfo

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.

JSON representation
{
  "customModelType": enum (CustomModelType),
  "baseProcessorVersionId": string
}
Fields
customModelType

enum (CustomModelType)

The type of custom model created by the user.

baseProcessorVersionId

string

The base processor version ID for the custom model.