REST Resource: projects.locations.documentSchemas

{
  "name": string,
  "displayName": string,
  "propertyDefinitions": [
    {
      object (PropertyDefinition)
    }
  ],
  "documentIsFolder": boolean,
  "updateTime": string,
  "createTime": string,
  "description": string
}

string

The resource name of the document schema. Format: projects/{projectNumber}/locations/{location}/documentSchemas/{document_schema_id}.

The name is ignored when creating a document schema.

string

Required. name of the schema given by the user. Must be unique per project.

object (PropertyDefinition)

Document details.

boolean

Document type, true refers the document is a folder, otherwise it is a typical document.

string (Timestamp format)

Output only. The time when the document schema is last updated.

A timestamp in RFC3339 UTC "Zulu" format, with nanosecond resolution and up to nine fractional digits. Examples: "2014-10-02T15:01:23Z" and "2014-10-02T15:01:23.045123456Z".

string (Timestamp format)

Output only. The time when the document schema is created.

A timestamp in RFC3339 UTC "Zulu" format, with nanosecond resolution and up to nine fractional digits. Examples: "2014-10-02T15:01:23Z" and "2014-10-02T15:01:23.045123456Z".

string

Schema description.

{
  "name": string,
  "displayName": string,
  "isRepeatable": boolean,
  "isFilterable": boolean,
  "isSearchable": boolean,
  "isMetadata": boolean,
  "isRequired": boolean,
  "retrievalImportance": enum (RetrievalImportance),
  "schemaSources": [
    {
      object (SchemaSource)
    }
  ],

  // Union field value_type_options can be only one of the following:
  "integerTypeOptions": {
    object (IntegerTypeOptions)
  },
  "floatTypeOptions": {
    object (FloatTypeOptions)
  },
  "textTypeOptions": {
    object (TextTypeOptions)
  },
  "propertyTypeOptions": {
    object (PropertyTypeOptions)
  },
  "enumTypeOptions": {
    object (EnumTypeOptions)
  },
  "dateTimeTypeOptions": {
    object (DateTimeTypeOptions)
  },
  "mapTypeOptions": {
    object (MapTypeOptions)
  },
  "timestampTypeOptions": {
    object (TimestampTypeOptions)
  }
  // End of list of possible types for union field value_type_options.
}

string

Required. The name of the metadata property. Must be unique within a document schema and is case insensitive. Names must be non-blank, start with a letter, and can contain alphanumeric characters and: /, :, -, _, and .

string

The display-name for the property, used for front-end.

boolean

Whether the property can have multiple values.

boolean

Whether the property can be filtered. If this is a sub-property, all the parent properties must be marked filterable.

boolean

Indicates that the property should be included in a global search.

boolean

Whether the property is user supplied metadata. This out-of-the box placeholder setting can be used to tag derived properties. Its value and interpretation logic should be implemented by API user.

boolean

Whether the property is mandatory. Default is 'false', i.e. populating property value can be skipped. If 'true' then user must populate the value for this property.

enum (RetrievalImportance)

The retrieval importance of the property during search.

object (SchemaSource)

The mapping information between this property to another schema source.

object (IntegerTypeOptions)

Integer property.

object (FloatTypeOptions)

Float property.

object (TextTypeOptions)

text/string property.

object (PropertyTypeOptions)

Nested structured data property.

object (EnumTypeOptions)

Enum/categorical property.

object (DateTimeTypeOptions)

date time property. It is not supported by CMEK compliant deployment.

object (MapTypeOptions)

Map property.

object (TimestampTypeOptions)

timestamp property. It is not supported by CMEK compliant deployment.

{
  "propertyDefinitions": [
    {
      object (PropertyDefinition)
    }
  ]
}

object (PropertyDefinition)

Required. List of property definitions.

{
  "possibleValues": [
    string
  ],
  "validationCheckDisabled": boolean
}

string

Required. List of possible enum values.

boolean

Make sure the Enum property value provided in the document is in the possile value list during document creation. The validation check runs by default.

{
  "name": string,
  "processorType": string
}

string

The schema name in the source.

string

The Doc AI processor type name.