This product is not supported for your selected Datadog site. ().

gcp_documentai_processor_version

ancestors

Type: UNORDERED_LIST_STRING

create_time

Type: TIMESTAMP
Provider name: createTime
Description: Output only. The time the processor version was created.

deprecation_info

Type: STRUCT
Provider name: deprecationInfo
Description: Output only. If set, information about the eventual deprecation of this version.

  • deprecation_time
    Type: TIMESTAMP
    Provider name: deprecationTime
    Description: The time at which this processor version will be deprecated.
  • replacement_processor_version
    Type: STRING
    Provider name: replacementProcessorVersion
    Description: If set, the processor version that will be used as a replacement.

document_schema

Type: STRUCT
Provider name: documentSchema
Description: Output only. The schema of the processor version. Describes the output.

  • description
    Type: STRING
    Provider name: description
    Description: Description of the schema.
  • entity_types
    Type: UNORDERED_LIST_STRUCT
    Provider name: entityTypes
    Description: Entity types of the schema.
    • base_types
      Type: UNORDERED_LIST_STRING
      Provider name: baseTypes
      Description: The entity type that this type is derived from. For now, one and only one should be set.
    • enum_values
      Type: STRUCT
      Provider name: enumValues
      Description: 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.
      • values
        Type: UNORDERED_LIST_STRING
        Provider name: values
        Description: The individual values that this enum values type can include.
    • gcp_display_name
      Type: STRING
      Provider name: displayName
      Description: User defined name for the type.
    • name
      Type: STRING
      Provider name: name
      Description: 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_-]. (For backward compatibility internal infrastructure and tooling can handle any ascii character.) - The / is sometimes used to denote a property of a type. For example line_item/amount. This convention is deprecated, but will still be honored for backward compatibility.
    • properties
      Type: UNORDERED_LIST_STRUCT
      Provider name: properties
      Description: Description the nested structure, or composition of an entity.
      • gcp_display_name
        Type: STRING
        Provider name: displayName
        Description: User defined name for the property.
      • method
        Type: STRING
        Provider name: method
        Description: Specifies how the entity’s value is obtained.
        Possible values:
        • METHOD_UNSPECIFIED - Unspecified method. It defaults to EXTRACT.
        • EXTRACT - The entity’s value is directly extracted as-is from the document text.
        • DERIVE - The entity’s value is derived through inference and is not necessarily an exact text extraction from the document.
      • name
        Type: STRING
        Provider name: name
        Description: The name of the property. Follows the same guidelines as the EntityType name.
      • occurrence_type
        Type: STRING
        Provider name: occurrenceType
        Description: Occurrence type limits the number of instances an entity type appears in the document.
        Possible values:
        • OCCURRENCE_TYPE_UNSPECIFIED - Unspecified occurrence type.
        • OPTIONAL_ONCE - There will be zero or one instance of this entity type. The same entity instance may be mentioned multiple times.
        • OPTIONAL_MULTIPLE - The entity type will appear zero or multiple times.
        • REQUIRED_ONCE - The entity type will only appear exactly once. The same entity instance may be mentioned multiple times.
        • REQUIRED_MULTIPLE - The entity type will appear once or more times.
      • value_type
        Type: STRING
        Provider name: valueType
        Description: A reference to the value type of the property. This type is subject to the same conventions as the Entity.base_types field.
  • gcp_display_name
    Type: STRING
    Provider name: displayName
    Description: Display name to show to users.
  • metadata
    Type: STRUCT
    Provider name: metadata
    Description: Metadata of the schema.
    • document_allow_multiple_labels
      Type: BOOLEAN
      Provider name: documentAllowMultipleLabels
      Description: If true, on a given page, there can be multiple document annotations covering it.
    • document_splitter
      Type: BOOLEAN
      Provider name: documentSplitter
      Description: If true, a document entity type can be applied to subdocument (splitting). Otherwise, it can only be applied to the entire document (classification).
    • prefixed_naming_on_properties
      Type: BOOLEAN
      Provider name: prefixedNamingOnProperties
      Description: If set, all the nested entities must be prefixed with the parents.
    • skip_naming_validation
      Type: BOOLEAN
      Provider name: skipNamingValidation
      Description: If set, we will skip the naming format validation in the schema. So the string values in DocumentSchema.EntityType.name and DocumentSchema.EntityType.Property.name will not be checked.

gcp_display_name

Type: STRING
Provider name: displayName
Description: The display name of the processor version.

gen_ai_model_info

Type: STRUCT
Provider name: genAiModelInfo
Description: Output only. Information about Generative AI model-based processor versions.

  • custom_gen_ai_model_info
    Type: STRUCT
    Provider name: customGenAiModelInfo
    Description: Information for a custom Generative AI model created by the user.
    • base_processor_version_id
      Type: STRING
      Provider name: baseProcessorVersionId
      Description: The base processor version ID for the custom model.
    • custom_model_type
      Type: STRING
      Provider name: customModelType
      Description: The type of custom model created by the user.
      Possible values:
      • CUSTOM_MODEL_TYPE_UNSPECIFIED - The model type is unspecified.
      • VERSIONED_FOUNDATION - The model is a versioned foundation model.
      • FINE_TUNED - The model is a finetuned foundation model.
  • foundation_gen_ai_model_info
    Type: STRUCT
    Provider name: foundationGenAiModelInfo
    Description: Information for a pretrained Google-managed foundation model.
    • finetuning_allowed
      Type: BOOLEAN
      Provider name: finetuningAllowed
      Description: Whether finetuning is allowed for this base processor version.
    • min_train_labeled_documents
      Type: INT32
      Provider name: minTrainLabeledDocuments
      Description: The minimum number of labeled documents in the training dataset required for finetuning.

google_managed

Type: BOOLEAN
Provider name: googleManaged
Description: Output only. Denotes that this ProcessorVersion is managed by Google.

kms_key_name

Type: STRING
Provider name: kmsKeyName
Description: Output only. The KMS key name used for encryption.

kms_key_version_name

Type: STRING
Provider name: kmsKeyVersionName
Description: Output only. The KMS key version with which data is encrypted.

labels

Type: UNORDERED_LIST_STRING

latest_evaluation

Type: STRUCT
Provider name: latestEvaluation
Description: Output only. The most recently invoked evaluation for the processor version.

  • aggregate_metrics
    Type: STRUCT
    Provider name: aggregateMetrics
    Description: An aggregate of the statistics for the evaluation with fuzzy matching on.
    • f1_score
      Type: FLOAT
      Provider name: f1Score
      Description: The calculated f1 score.
    • false_negatives_count
      Type: INT32
      Provider name: falseNegativesCount
      Description: The amount of false negatives.
    • false_positives_count
      Type: INT32
      Provider name: falsePositivesCount
      Description: The amount of false positives.
    • ground_truth_document_count
      Type: INT32
      Provider name: groundTruthDocumentCount
      Description: The amount of documents with a ground truth occurrence.
    • ground_truth_occurrences_count
      Type: INT32
      Provider name: groundTruthOccurrencesCount
      Description: The amount of occurrences in ground truth documents.
    • precision
      Type: FLOAT
      Provider name: precision
      Description: The calculated precision.
    • predicted_document_count
      Type: INT32
      Provider name: predictedDocumentCount
      Description: The amount of documents with a predicted occurrence.
    • predicted_occurrences_count
      Type: INT32
      Provider name: predictedOccurrencesCount
      Description: The amount of occurrences in predicted documents.
    • recall
      Type: FLOAT
      Provider name: recall
      Description: The calculated recall.
    • total_documents_count
      Type: INT32
      Provider name: totalDocumentsCount
      Description: The amount of documents that had an occurrence of this label.
    • true_positives_count
      Type: INT32
      Provider name: truePositivesCount
      Description: The amount of true positives.
  • aggregate_metrics_exact
    Type: STRUCT
    Provider name: aggregateMetricsExact
    Description: An aggregate of the statistics for the evaluation with fuzzy matching off.
    • f1_score
      Type: FLOAT
      Provider name: f1Score
      Description: The calculated f1 score.
    • false_negatives_count
      Type: INT32
      Provider name: falseNegativesCount
      Description: The amount of false negatives.
    • false_positives_count
      Type: INT32
      Provider name: falsePositivesCount
      Description: The amount of false positives.
    • ground_truth_document_count
      Type: INT32
      Provider name: groundTruthDocumentCount
      Description: The amount of documents with a ground truth occurrence.
    • ground_truth_occurrences_count
      Type: INT32
      Provider name: groundTruthOccurrencesCount
      Description: The amount of occurrences in ground truth documents.
    • precision
      Type: FLOAT
      Provider name: precision
      Description: The calculated precision.
    • predicted_document_count
      Type: INT32
      Provider name: predictedDocumentCount
      Description: The amount of documents with a predicted occurrence.
    • predicted_occurrences_count
      Type: INT32
      Provider name: predictedOccurrencesCount
      Description: The amount of occurrences in predicted documents.
    • recall
      Type: FLOAT
      Provider name: recall
      Description: The calculated recall.
    • total_documents_count
      Type: INT32
      Provider name: totalDocumentsCount
      Description: The amount of documents that had an occurrence of this label.
    • true_positives_count
      Type: INT32
      Provider name: truePositivesCount
      Description: The amount of true positives.
  • evaluation
    Type: STRING
    Provider name: evaluation
    Description: The resource name of the evaluation.
  • operation
    Type: STRING
    Provider name: operation
    Description: The resource name of the Long Running Operation for the evaluation.

model_type

Type: STRING
Provider name: modelType
Description: Output only. The model type of this processor version.
Possible values:

  • MODEL_TYPE_UNSPECIFIED - The processor version has unspecified model type.
  • MODEL_TYPE_GENERATIVE - The processor version has generative model type.
  • MODEL_TYPE_CUSTOM - The processor version has custom model type.

name

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

organization_id

Type: STRING

parent

Type: STRING

project_id

Type: STRING

project_number

Type: STRING

resource_name

Type: STRING

satisfies_pzi

Type: BOOLEAN
Provider name: satisfiesPzi
Description: Output only. Reserved for future use.

satisfies_pzs

Type: BOOLEAN
Provider name: satisfiesPzs
Description: Output only. Reserved for future use.

state

Type: STRING
Provider name: state
Description: Output only. The state of the processor version.
Possible values:

  • STATE_UNSPECIFIED - The processor version is in an unspecified state.
  • DEPLOYED - The processor version is deployed and can be used for processing.
  • DEPLOYING - The processor version is being deployed.
  • UNDEPLOYED - The processor version is not deployed and cannot be used for processing.
  • UNDEPLOYING - The processor version is being undeployed.
  • CREATING - The processor version is being created.
  • DELETING - The processor version is being deleted.
  • FAILED - The processor version failed and is in an indeterminate state.
  • IMPORTING - The processor version is being imported.

tags

Type: UNORDERED_LIST_STRING