Package com.google.cloud.documentai.v1beta3

Interface DocumentSchemaOrBuilder

All Superinterfaces:
com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder
All Known Implementing Classes:
DocumentSchema, DocumentSchema.Builder
@Generated public interface DocumentSchemaOrBuilder extends com.google.protobuf.MessageOrBuilder

  • Method Details

    • getDisplayName

      String getDisplayName()
       Display name to show users.
      string display_name = 1;
      Returns:
      The displayName.

    • getDisplayNameBytes

      com.google.protobuf.ByteString getDisplayNameBytes()
       Display name to show users.
      string display_name = 1;
      Returns:
      The bytes for displayName.

    • getDescription

      String getDescription()
       Description of the schema.
      string description = 2;
      Returns:
      The description.

    • getDescriptionBytes

      com.google.protobuf.ByteString getDescriptionBytes()
       Description of the schema.
      string description = 2;
      Returns:
      The bytes for description.

    • getEntityTypesList

      List<DocumentSchema.EntityType> getEntityTypesList()
       Entity types of the schema.
      repeated .google.cloud.documentai.v1beta3.DocumentSchema.EntityType entity_types = 3;

    • getEntityTypes

      DocumentSchema.EntityType getEntityTypes(int index)
       Entity types of the schema.
      repeated .google.cloud.documentai.v1beta3.DocumentSchema.EntityType entity_types = 3;

    • getEntityTypesCount

      int getEntityTypesCount()
       Entity types of the schema.
      repeated .google.cloud.documentai.v1beta3.DocumentSchema.EntityType entity_types = 3;

    • getEntityTypesOrBuilderList

      List<? extends DocumentSchema.EntityTypeOrBuilder> getEntityTypesOrBuilderList()
       Entity types of the schema.
      repeated .google.cloud.documentai.v1beta3.DocumentSchema.EntityType entity_types = 3;

    • getEntityTypesOrBuilder

      DocumentSchema.EntityTypeOrBuilder getEntityTypesOrBuilder(int index)
       Entity types of the schema.
      repeated .google.cloud.documentai.v1beta3.DocumentSchema.EntityType entity_types = 3;

    • hasMetadata

      boolean hasMetadata()
       Metadata of the schema.
      .google.cloud.documentai.v1beta3.DocumentSchema.Metadata metadata = 4;
      Returns:
      Whether the metadata field is set.

    • getMetadata

      DocumentSchema.Metadata getMetadata()
       Metadata of the schema.
      .google.cloud.documentai.v1beta3.DocumentSchema.Metadata metadata = 4;
      Returns:
      The metadata.

    • getMetadataOrBuilder

      DocumentSchema.MetadataOrBuilder getMetadataOrBuilder()
       Metadata of the schema.
      .google.cloud.documentai.v1beta3.DocumentSchema.Metadata metadata = 4;

    • getDocumentPrompt

      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:
      The documentPrompt.

    • getDocumentPromptBytes

      com.google.protobuf.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:
      The bytes for documentPrompt.