Interface DocumentSchemaOrBuilder (2.89.0) 

public interface DocumentSchemaOrBuilder extends MessageOrBuilder

Implements

MessageOrBuilder

Methods

getDescription()

public abstract String getDescription()

Description of the schema.

string description = 2;

Returns
Type Description
String

The description.

getDescriptionBytes()

public abstract ByteString getDescriptionBytes()

Description of the schema.

string description = 2;

Returns
Type Description
ByteString

The bytes for description.

getDisplayName()

public abstract String getDisplayName()

Display name to show users.

string display_name = 1;

Returns
Type Description
String

The displayName.

getDisplayNameBytes()

public abstract ByteString getDisplayNameBytes()

Display name to show users.

string display_name = 1;

Returns
Type Description
ByteString

The bytes for displayName.

getDocumentPrompt()

public abstract String getDocumentPrompt()

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.

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

Returns
Type Description
String

The documentPrompt.

getDocumentPromptBytes()

public abstract ByteString getDocumentPromptBytes()

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.

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

Returns
Type Description
ByteString

The bytes for documentPrompt.

getEntityTypes(int index)

public abstract DocumentSchema.EntityType getEntityTypes(int index)

Entity types of the schema.

repeated .google.cloud.documentai.v1beta3.DocumentSchema.EntityType entity_types = 3;

Parameter
Name Description
index int
Returns
Type Description
DocumentSchema.EntityType

getEntityTypesCount()

public abstract int getEntityTypesCount()

Entity types of the schema.

repeated .google.cloud.documentai.v1beta3.DocumentSchema.EntityType entity_types = 3;

Returns
Type Description
int

getEntityTypesList()

public abstract List<DocumentSchema.EntityType> getEntityTypesList()

Entity types of the schema.

repeated .google.cloud.documentai.v1beta3.DocumentSchema.EntityType entity_types = 3;

Returns
Type Description
List<EntityType>

getEntityTypesOrBuilder(int index)

public abstract DocumentSchema.EntityTypeOrBuilder getEntityTypesOrBuilder(int index)

Entity types of the schema.

repeated .google.cloud.documentai.v1beta3.DocumentSchema.EntityType entity_types = 3;

Parameter
Name Description
index int
Returns
Type Description
DocumentSchema.EntityTypeOrBuilder

getEntityTypesOrBuilderList()

public abstract List<? extends DocumentSchema.EntityTypeOrBuilder> getEntityTypesOrBuilderList()

Entity types of the schema.

repeated .google.cloud.documentai.v1beta3.DocumentSchema.EntityType entity_types = 3;

Returns
Type Description
List<? extends com.google.cloud.documentai.v1beta3.DocumentSchema.EntityTypeOrBuilder>

getMetadata()

public abstract DocumentSchema.Metadata getMetadata()

Metadata of the schema.

.google.cloud.documentai.v1beta3.DocumentSchema.Metadata metadata = 4;

Returns
Type Description
DocumentSchema.Metadata

The metadata.

getMetadataOrBuilder()

public abstract DocumentSchema.MetadataOrBuilder getMetadataOrBuilder()

Metadata of the schema.

.google.cloud.documentai.v1beta3.DocumentSchema.Metadata metadata = 4;

Returns
Type Description
DocumentSchema.MetadataOrBuilder

hasMetadata()

public abstract boolean hasMetadata()

Metadata of the schema.

.google.cloud.documentai.v1beta3.DocumentSchema.Metadata metadata = 4;

Returns
Type Description
boolean

Whether the metadata field is set.