Googly.DocumentAI.Model.GoogleCloudDocumentaiV1Processor (googly_document_ai v0.1.2)

Copy Markdown View Source

The first-class citizen for Document AI. Each processor defines how to extract structural information from a document.

Attributes

  • active_schema_version (type: String.t()) - Optional. SchemaVersion used by the Processor. It is the same as Processor's DatasetSchema.schema_version Format is projects/{project}/locations/{location}/schemas/{schema}/schemaVersions/{schema_version}
  • create_time (type: DateTime.t()) - Output only. The time the processor was created.
  • default_processor_version (type: String.t()) - The default processor version.
  • display_name (type: String.t()) - The display name of the processor.
  • kms_key_name (type: String.t()) - The KMS key used for encryption and decryption in CMEK scenarios.
  • name (type: String.t()) - Output only. Immutable. The resource name of the processor. Format: projects/{project}/locations/{location}/processors/{processor}
  • process_endpoint (type: String.t()) - Output only. Immutable. The http endpoint that can be called to invoke processing.
  • processor_version_aliases (type: list(Googly.DocumentAI.Model.GoogleCloudDocumentaiV1ProcessorVersionAlias.t())) - Output only. The processor version aliases.
  • satisfies_pzi (type: boolean()) - Output only. Reserved for future use.
  • satisfies_pzs (type: boolean()) - Output only. Reserved for future use.
  • state (type: String.t()) - Output only. The state of the processor.
  • type (type: String.t()) - The processor type, such as: OCR_PROCESSOR, INVOICE_PROCESSOR. To get a list of processor types, see FetchProcessorTypes.

Summary

Types

t()

@type t() :: %Googly.DocumentAI.Model.GoogleCloudDocumentaiV1Processor{
  active_schema_version: String.t() | nil,
  create_time: DateTime.t() | nil,
  default_processor_version: String.t() | nil,
  display_name: String.t() | nil,
  kms_key_name: String.t() | nil,
  name: String.t() | nil,
  process_endpoint: String.t() | nil,
  processor_version_aliases:
    [Googly.DocumentAI.Model.GoogleCloudDocumentaiV1ProcessorVersionAlias.t()]
    | nil,
  satisfies_pzi: boolean() | nil,
  satisfies_pzs: boolean() | nil,
  state: String.t() | nil,
  type: String.t() | nil
}