DocumentAIProcessorVersion

Property	Value
Google Cloud Service Name	Document AI
Google Cloud Service Documentation	/document-ai/docs/
Google Cloud REST Resource Name	projects.locations.processors.processorVersions
Google Cloud REST Resource Documentation	/document-ai/docs/reference/rest/v1/projects.locations.processors.processorVersions
Config Connector Resource Short Names	gcpdocumentaiprocessorversion gcpdocumentaiprocessorversions documentaiprocessorversion
Config Connector Service Name	documentai.googleapis.com
Config Connector Resource Fully Qualified Name	documentaiprocessorversions.documentai.cnrm.cloud.google.com
Can Be Referenced by IAMPolicy/IAMPolicyMember	No
Config Connector Default Average Reconcile Interval In Seconds	600

Custom Resource Definition Properties

Spec

Schema

deprecationInfo:
  deprecationTime: string
  replacementProcessorVersion: string
displayName: string
kmsKeyNameRef:
  external: string
  name: string
  namespace: string
kmsKeyVersionNameRef:
  external: string
processorRef:
  external: string
  name: string
  namespace: string
resourceID: string

Fields
deprecationInfo Optional	object If set, information about the eventual deprecation of this version.
deprecationInfo.deprecationTime Optional	string The time at which this processor version will be retired.
deprecationInfo.replacementProcessorVersion Optional	string If set, the processor version that will be used as a replacement.
displayName Optional	string The display name of the processor version.
kmsKeyNameRef Optional	object The KMS key name used for encryption.
kmsKeyNameRef.external Optional	string A reference to an externally managed KMSCryptoKey. Should be in the format `projects/[kms_project_id]/locations/[region]/keyRings/[key_ring_id]/cryptoKeys/[key]`.
kmsKeyNameRef.name Optional	string The `name` of a `KMSCryptoKey` resource.
kmsKeyNameRef.namespace Optional	string The `namespace` of a `KMSCryptoKey` resource.
kmsKeyVersionNameRef Optional	object The KMS key version with which data is encrypted.
kmsKeyVersionNameRef.external Optional	string A reference to an externally managed cryptoKeyVersion. Should be in the format `projects/{{kms_project_id}}/locations/{{region}}/keyRings/{{key_ring_id}}/cryptoKeys/{{key}}/cryptoKeyVersions/{{version}}`.
processorRef Required	object ProcessorRef defines the resource reference to DocumentAIProcessor, which "External" field holds the Google Cloud identifier for the KRM object.
processorRef.external Optional	string A reference to an externally managed DocumentAIProcessor resource. Should be in the format "projects/{{projectID}}/locations/{{location}}/processors/{{processorID}}".
processorRef.name Optional	string The name of a DocumentAIProcessor resource.
processorRef.namespace Optional	string The namespace of a DocumentAIProcessor resource.
resourceID Optional	string The DocumentAIProcessorVersion name. If not given, the metadata.name will be used.

Status

Schema

conditions:
- lastTransitionTime: string
  message: string
  reason: string
  status: string
  type: string
externalRef: string
observedGeneration: integer
observedState:
  create_time: string
  document_schema:
    description: string
    displayName: string
    entityTypes:
    - baseTypes:
      - string
      displayName: string
      enumValues:
        values:
        - string
      name: string
      properties:
      - displayName: string
        method: string
        name: string
        occurrenceType: string
        valueType: string
    metadata:
      documentAllowMultipleLabels: boolean
      documentSplitter: boolean
      prefixedNamingOnProperties: boolean
      skipNamingValidation: boolean
  gen_ai_model_info:
    customGenAiModelInfo:
      baseProcessorVersionID: string
      customModelType: string
    foundationGenAiModelInfo:
      finetuningAllowed: boolean
      minTrainLabeledDocuments: integer
  google_managed: boolean
  latest_evaluation:
    aggregateMetrics:
      f1Score: float
      falseNegativesCount: integer
      falsePositivesCount: integer
      groundTruthDocumentCount: integer
      groundTruthOccurrencesCount: integer
      precision: float
      predictedDocumentCount: integer
      predictedOccurrencesCount: integer
      recall: float
      totalDocumentsCount: integer
      truePositivesCount: integer
    aggregateMetricsExact:
      f1Score: float
      falseNegativesCount: integer
      falsePositivesCount: integer
      groundTruthDocumentCount: integer
      groundTruthOccurrencesCount: integer
      precision: float
      predictedDocumentCount: integer
      predictedOccurrencesCount: integer
      recall: float
      totalDocumentsCount: integer
      truePositivesCount: integer
    evaluation: string
    operation: string
  model_type: string
  satisfies_pzi: boolean
  satisfies_pzs: boolean
  state: string

Fields
conditions	list (object) Conditions represent the latest available observations of the object's current state.
conditions[]	object
conditions[].lastTransitionTime	string Last time the condition transitioned from one status to another.
conditions[].message	string Human-readable message indicating details about last transition.
conditions[].reason	string Unique, one-word, CamelCase reason for the condition's last transition.
conditions[].status	string Status is the status of the condition. Can be True, False, Unknown.
conditions[].type	string Type is the type of the condition.
externalRef	string A unique specifier for the DocumentAI resource in Google Cloud.
observedGeneration	integer ObservedGeneration is the generation of the resource that was most recently observed by the Config Connector controller. If this is equal to metadata.generation, then that means that the current reported status reflects the most recent desired state of the resource.
observedState	object ObservedState is the state of the resource as most recently observed in Google Cloud.
observedState.create_time	string The time the processor version was created.
observedState.document_schema	object The schema of the processor version. Describes the output.
observedState.document_schema.description	string Description of the schema.
observedState.document_schema.displayName	string Display name to show to users.
observedState.document_schema.entityTypes	list (object) Entity types of the schema.
observedState.document_schema.entityTypes[]	object
observedState.document_schema.entityTypes[].baseTypes	list (string) The entity type that this type is derived from. For now, one and only one should be set.
observedState.document_schema.entityTypes[].baseTypes[]	string
observedState.document_schema.entityTypes[].displayName	string User defined name for the type.
observedState.document_schema.entityTypes[].enumValues	object If specified, lists all the possible values for this entity. This should not be more than a handful of values. If the number of values is >10 or could change frequently use the `EntityType.value_ontology` field and specify a list of all possible values in a value ontology file.
observedState.document_schema.entityTypes[].enumValues.values	list (string) The individual values that this enum values type can include.
observedState.document_schema.entityTypes[].enumValues.values[]	string
observedState.document_schema.entityTypes[].name	string Name of the type. It must be unique within the schema file and cannot be a "Common Type". The following naming conventions are used: Use snake_casing. Name matching is case-sensitive. Maximum 64 characters. Must start with a letter. Allowed characters: ASCII letters [a-z0-9_-]. The / is sometimes used to denote a property of a type. For example line_item/amount. This convention is not supported, but will still be honored for backward compatibility.
observedState.document_schema.entityTypes[].properties	list (object) Description the nested structure, or composition of an entity.
observedState.document_schema.entityTypes[].properties[]	object
observedState.document_schema.entityTypes[].properties[].displayName	string User defined name for the property.
observedState.document_schema.entityTypes[].properties[].method	string Specifies how the entity's value is obtained.
observedState.document_schema.entityTypes[].properties[].name	string The name of the property. Follows the same guidelines as the EntityType name.
observedState.document_schema.entityTypes[].properties[].occurrenceType	string Occurrence type limits the number of instances an entity type appears in the document.
observedState.document_schema.entityTypes[].properties[].valueType	string A reference to the value type of the property. This type is subject to the same conventions as the `Entity.base_types` field.
observedState.document_schema.metadata	object Metadata of the schema.
observedState.document_schema.metadata.documentAllowMultipleLabels	boolean If true, on a given page, there can be multiple `document` annotations covering it.
observedState.document_schema.metadata.documentSplitter	boolean If true, a `document` entity type can be applied to subdocument (splitting). Otherwise, it can only be applied to the entire document (classification).
observedState.document_schema.metadata.prefixedNamingOnProperties	boolean If set, all the nested entities must be prefixed with the parents.
observedState.document_schema.metadata.skipNamingValidation	boolean If set, skips the naming format validation in the schema, meaning the string values in `DocumentSchema.EntityType.name` and `DocumentSchema.EntityType.Property.name` will not be checked.
observedState.gen_ai_model_info	object Output only. Information about Generative AI model-based processor versions.
observedState.gen_ai_model_info.customGenAiModelInfo	object Information for a custom Generative AI model.
observedState.gen_ai_model_info.customGenAiModelInfo.baseProcessorVersionID	string The base processor version ID for the custom model.
observedState.gen_ai_model_info.customGenAiModelInfo.customModelType	string The type of custom model created by the user.
observedState.gen_ai_model_info.foundationGenAiModelInfo	object Information for a pretrained Google-managed foundation model.
observedState.gen_ai_model_info.foundationGenAiModelInfo.finetuningAllowed	boolean Whether finetuning is allowed for this base processor version.
observedState.gen_ai_model_info.foundationGenAiModelInfo.minTrainLabeledDocuments	integer The minimum number of labeled documents in the training dataset required for finetuning.
observedState.google_managed	boolean Output only. Denotes that this `ProcessorVersion` is managed by Google.
observedState.latest_evaluation	object The most recently invoked evaluation for the processor version.
observedState.latest_evaluation.aggregateMetrics	object An aggregate of the statistics for the evaluation with fuzzy matching on.
observedState.latest_evaluation.aggregateMetrics.f1Score	float The calculated F1 score.
observedState.latest_evaluation.aggregateMetrics.falseNegativesCount	integer The amount of false negatives.
observedState.latest_evaluation.aggregateMetrics.falsePositivesCount	integer The amount of false positives.
observedState.latest_evaluation.aggregateMetrics.groundTruthDocumentCount	integer The amount of documents with a ground truth occurrence.
observedState.latest_evaluation.aggregateMetrics.groundTruthOccurrencesCount	integer The amount of occurrences in ground truth documents.
observedState.latest_evaluation.aggregateMetrics.precision	float The calculated precision.
observedState.latest_evaluation.aggregateMetrics.predictedDocumentCount	integer The amount of documents with a predicted occurrence.
observedState.latest_evaluation.aggregateMetrics.predictedOccurrencesCount	integer The amount of occurrences in predicted documents.
observedState.latest_evaluation.aggregateMetrics.recall	float The calculated recall.
observedState.latest_evaluation.aggregateMetrics.totalDocumentsCount	integer The amount of documents that had an occurrence of this label.
observedState.latest_evaluation.aggregateMetrics.truePositivesCount	integer The amount of true positives.
observedState.latest_evaluation.aggregateMetricsExact	object An aggregate of the statistics for the evaluation with fuzzy matching off.
observedState.latest_evaluation.aggregateMetricsExact.f1Score	float The calculated f1 score.
observedState.latest_evaluation.aggregateMetricsExact.falseNegativesCount	integer The amount of false negatives.
observedState.latest_evaluation.aggregateMetricsExact.falsePositivesCount	integer The amount of false positives.
observedState.latest_evaluation.aggregateMetricsExact.groundTruthDocumentCount	integer The amount of documents with a ground truth occurrence.
observedState.latest_evaluation.aggregateMetricsExact.groundTruthOccurrencesCount	integer The amount of occurrences in ground truth documents.
observedState.latest_evaluation.aggregateMetricsExact.precision	float The calculated precision.
observedState.latest_evaluation.aggregateMetricsExact.predictedDocumentCount	integer The amount of documents with a predicted occurrence.
observedState.latest_evaluation.aggregateMetricsExact.predictedOccurrencesCount	integer The amount of occurrences in predicted documents.
observedState.latest_evaluation.aggregateMetricsExact.recall	float The calculated recall.
observedState.latest_evaluation.aggregateMetricsExact.totalDocumentsCount	integer The amount of documents that had an occurrence of this label.
observedState.latest_evaluation.aggregateMetricsExact.truePositivesCount	integer The amount of true positives.
observedState.latest_evaluation.evaluation	string The resource name of the evaluation.
observedState.latest_evaluation.operation	string The resource name of the Long Running Operation for the evaluation.
observedState.model_type	string Output only. The model type of this processor version.
observedState.satisfies_pzi	boolean Output only. Reserved for future use.
observedState.satisfies_pzs	boolean Output only. Reserved for future use.
observedState.state	string Output only. The state of the processor version.

Note: If you have any trouble with instantiating the resource, refer to Troubleshoot Config Connector.