// Copyright 2025 Google LLC

// Copyright 2026 Google LLC

//

// Licensed under the Apache License, Version 2.0 (the "License");

// you may not use this file except in compliance with the License.

package google.cloud.documentai.v1beta3;

import "google/api/field_behavior.proto";

import "google/api/resource.proto";

import "google/cloud/documentai/v1beta3/barcode.proto";

import "google/cloud/documentai/v1beta3/geometry.proto";

import "google/protobuf/timestamp.proto";

repeated DetectedLanguage detected_languages = 2;

}

// Detected non-text visual elements, for example, checkbox, signature, etc.

// Detected non-text visual elements, for example, checkbox, signature etc.

// on the page.

message VisualElement {

// [Layout][google.cloud.documentai.v1beta3.Document.Page.Layout] for

// A list of visually detected tokens on the page.

repeated Token tokens = 8;

// A list of detected non-text visual elements for example, checkbox,

// A list of detected non-text visual elements, for example, checkbox,

// signature etc. on the page.

repeated VisualElement visual_elements = 9;

// [Document.text][google.cloud.documentai.v1beta3.Document.text].

TextAnchor text_anchor = 1 [(google.api.field_behavior) = OPTIONAL];

// Required. Entity type from a schema for example, `Address`.

// Required. Entity type from a schema, for example, `Address`.

string type = 2 [(google.api.field_behavior) = REQUIRED];

// Optional. Text value of the entity for example, `1600 Amphitheatre Pkwy`.

// Optional. Text value of the entity, for example, `1600 Amphitheatre

// Pkwy`.

string mention_text = 3 [(google.api.field_behavior) = OPTIONAL];

// Optional. Deprecated. Use `id` field instead.

// the page where it was found.

PageAnchor page_anchor = 6 [(google.api.field_behavior) = OPTIONAL];

// Optional. Canonical ID. This will be a unique value in the entity list

// Optional. Canonical id. This will be a unique value in the entity list

// for this document.

string id = 7 [(google.api.field_behavior) = OPTIONAL];

// Relationship between

// [Entities][google.cloud.documentai.v1beta3.Document.Entity].

message EntityRelation {

// Subject entity ID.

// Subject entity id.

string subject_id = 1;

// Object entity ID.

// Object entity id.

string object_id = 2;

// Relationship description.

// of entities, properties within entities, etc.) in the parent revision.

int32 index = 3;

// The ID of the parent provenance.

// The id of the parent provenance.

int32 id = 2 [deprecated = true];

}

// The index of the revision that produced this element.

int32 revision = 1 [deprecated = true];

// The ID of this operation. Needs to be unique within the scope of the

// The Id of this operation. Needs to be unique within the scope of the

// revision.

int32 id = 2 [deprecated = true];

// Who/what made the change

oneof source {

// If the change was made by a person specify the name or ID of that

// If the change was made by a person specify the name or id of that

// person.

string agent = 4;

string processor = 5;

}

// ID of the revision, internally generated by doc proto storage.

// Id of the revision, internally generated by doc proto storage.

// Unique within the context of the document.

string id = 1;

// index into the `revisions` field.

repeated int32 parent = 2 [deprecated = true];

// The revisions that this revision is based on. Must include all the IDs

// The revisions that this revision is based on. Must include all the ids

// that have anything to do with this revision - eg. there are

// `provenance.parent.revision` fields that index into this field.

repeated string parent_ids = 7;

message LayoutImageBlock {

// Source of the image.

oneof image_source {

// Optional. Asset ID of the inline image. If set, find the image

// Optional. Asset id of the inline image. If set, find the image

// content in the blob_assets field.

string blob_asset_id = 4 [(google.api.field_behavior) = OPTIONAL];

// Optional. Google Cloud Storage URI of the image.

// Optional. Google Cloud Storage uri of the image.

string gcs_uri = 5 [(google.api.field_behavior) = OPTIONAL];

// Optional. Data URI of the image.

// Optional. Data uri of the image.

// It is composed of four parts: a prefix (data:), a MIME type

// indicating the type of data, an optional base64 token if

// non-textual, and the data itself:

// data:[<mediatype>][;base64],<data>.

// data:[<mediatype>][;base64],<data>

string data_uri = 6 [(google.api.field_behavior) = OPTIONAL];

}

message ImageChunkField {

// Source of the image.

oneof image_source {

// Optional. Asset ID of the inline image. If set, find the image

// Optional. Asset id of the inline image. If set, find the image

// content in the blob_assets field.

string blob_asset_id = 1 [(google.api.field_behavior) = OPTIONAL];

// Optional. Google Cloud Storage URI of the image.

// Optional. Google Cloud Storage uri of the image.

string gcs_uri = 2 [(google.api.field_behavior) = OPTIONAL];

// Optional. Data URI of the image.

// Optional. Data uri of the image.

// It is composed of four parts: a prefix (data:), a MIME type

// indicating the type of data, an optional base64 token if

// non-textual, and the data itself:

// data:[<mediatype>][;base64],<data>.

// data:[<mediatype>][;base64],<data>

string data_uri = 3 [(google.api.field_behavior) = OPTIONAL];

}

// in this document, for example, image bytes, such that it can be referenced

// by other fields in the document via asset ID.

message BlobAsset {

// Optional. The ID of the blob asset.

// Optional. The id of the blob asset.

string asset_id = 1 [(google.api.field_behavior) = OPTIONAL];

// Optional. The content of the blob asset, for example, image bytes.

VALIDATION_RESULT_TYPE_NOT_APPLICABLE = 4;

}

// The name of the validation rule.

// The display name of the validation rule.

string rule_name = 1;

// The description of the validation rule.

// Entity revision.

message EntitiesRevision {

// The revision ID.

// The revision id.

string revision_id = 1;

// The entities in this revision.

repeated Entity entities = 2;

// The entity validation output for this revision.

EntityValidationOutput entity_validation_output = 3;

// Optional. The history of this revision.

Provenance provenance = 4 [(google.api.field_behavior) = OPTIONAL];

}

// Original source document from the user.

// The entity revision ID that `document.entities` field is based on.

// If this field is set and `entities_revisions` is not empty, the entities in

// `document.entities` field are the entities in the entity revision with this

// ID and `document.entity_validation_output` field is the

// id and `document.entity_validation_output` field is the

// `entity_validation_output` field in this entity revision.

string entities_revision_id = 23;

}

// Reads the revision by the predefined case.

RevisionCase revision_case = 1;

// Reads the revision given by the ID.

// Reads the revision given by the id.

string revision_id = 2;

// Reads the revision generated by the processor version.