Class Dataset (2.24.2)

Version 2.24.2

• 3.0.0 (latest)
• 2.35.0
• 2.34.0
• 2.33.0
• 2.32.0
• 2.30.0
• 2.29.3
• 2.28.0
• 2.27.1
• 2.26.0
• 2.25.0
• 2.24.2
• 2.23.0
• 2.22.0
• 2.21.1
• 2.20.2
• 2.19.0
• 2.18.0
• 2.17.0
• 2.16.1
• 2.15.0
• 2.14.0
• 2.13.0
• 2.12.0
• 2.11.0
• 2.10.0
• 2.9.1
• 2.8.0
• 2.7.0
• 2.6.0
• 2.5.0
• 2.4.1
• 2.3.0
• 2.2.0
• 2.1.0
• 2.0.3
• 1.5.1
• 1.4.2
• 1.3.0
• 1.2.1
• 1.1.0
• 1.0.0
• 0.5.2
• 0.4.0
• 0.3.0
• 0.2.0
• 0.1.0

Dataset(mapping=None, *, ignore_unknown_fields=False, **kwargs)

A singleton resource under a Processor which configures a collection of documents.

This message has oneof_ fields (mutually exclusive fields). For each oneof, at most one member field can be set at the same time. Setting any member of the oneof automatically clears all other members.

.. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields

Attributes
Name	Description
gcs_managed_config	google.cloud.documentai_v1beta3.types.Dataset.GCSManagedConfig Optional. User-managed Cloud Storage dataset configuration. Use this configuration if the dataset documents are stored under a user-managed Cloud Storage location. This field is a member of oneof_ storage_source.
document_warehouse_config	google.cloud.documentai_v1beta3.types.Dataset.DocumentWarehouseConfig Optional. Deprecated. Warehouse-based dataset configuration is not supported. This field is a member of oneof_ storage_source.
unmanaged_dataset_config	google.cloud.documentai_v1beta3.types.Dataset.UnmanagedDatasetConfig Optional. Unmanaged dataset configuration. Use this configuration if the dataset documents are managed by the document service internally (not user-managed). This field is a member of oneof_ storage_source.
spanner_indexing_config	google.cloud.documentai_v1beta3.types.Dataset.SpannerIndexingConfig Optional. A lightweight indexing source with low latency and high reliability, but lacking advanced features like CMEK and content-based search. This field is a member of oneof_ indexing_source.
name	str Dataset resource name. Format: projects/{project}/locations/{location}/processors/{processor}/dataset
state	google.cloud.documentai_v1beta3.types.Dataset.State Required. State of the dataset. Ignored when updating dataset.

Classes

DocumentWarehouseConfig

DocumentWarehouseConfig(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Configuration specific to the Document AI Warehouse-based implementation.

GCSManagedConfig

GCSManagedConfig(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Configuration specific to the Cloud Storage-based implementation.

SpannerIndexingConfig

SpannerIndexingConfig(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Configuration specific to spanner-based indexing.

State

State(value)

Different states of a dataset.

Values: STATE_UNSPECIFIED (0): Default unspecified enum, should not be used. UNINITIALIZED (1): Dataset has not been initialized. INITIALIZING (2): Dataset is being initialized. INITIALIZED (3): Dataset has been initialized.

UnmanagedDatasetConfig

UnmanagedDatasetConfig(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Configuration specific to an unmanaged dataset.