Googly.DocumentAI.Model.GoogleCloudDocumentaiUiv1beta3DocumentSchema (googly_document_ai v0.1.0)

Copy Markdown View Source

The schema defines the output of the processed document by a processor.

Attributes

  • description (type: String.t()) - Description of the schema.
  • display_name (type: String.t()) - Display name to show users.
  • document_prompt (type: String.t()) - Optional. Document level prompt provided by the user. This custom text is injected into the AI model's prompt to provide extra, document-wide guidance for processing.
  • entity_types (type: list(Googly.DocumentAI.Model.GoogleCloudDocumentaiUiv1beta3DocumentSchemaEntityType.t())) - Entity types of the schema.
  • metadata (type: Googly.DocumentAI.Model.GoogleCloudDocumentaiUiv1beta3DocumentSchemaMetadata.t()) - Metadata of the schema.

Summary

Types

t()

Types

t()

@type t() :: %Googly.DocumentAI.Model.GoogleCloudDocumentaiUiv1beta3DocumentSchema{
  description: String.t() | nil,
  display_name: String.t() | nil,
  document_prompt: String.t() | nil,
  entity_types:
    [
      Googly.DocumentAI.Model.GoogleCloudDocumentaiUiv1beta3DocumentSchemaEntityType.t()
    ]
    | nil,
  metadata:
    Googly.DocumentAI.Model.GoogleCloudDocumentaiUiv1beta3DocumentSchemaMetadata.t()
    | nil
}