Class Corpus (0.1.8)

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

Corpus is a set of media contents for management. Within a corpus, media shares the same data schema. Search is also restricted within a single corpus.

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

Attributes

Name Description
name str
Resource name of the corpus. Format: projects/{project_number}/locations/{location_id}/corpora/{corpus_id}
display_name str
Required. The corpus name to shown in the UI. The name can be up to 32 characters long.
description str
Optional. Description of the corpus. Can be up to 25000 characters long.
default_ttl google.protobuf.duration_pb2.Duration
Optional. The default TTL value for all assets under the corpus without a asset level user-defined TTL. For STREAM_VIDEO type corpora, this is required and the maximum allowed default_ttl is 10 years.
type_ google.cloud.visionai_v1.types.Corpus.Type
Optional. Type of the asset inside corpus.
search_capability_setting google.cloud.visionai_v1.types.SearchCapabilitySetting
Default search capability setting on corpus level.
satisfies_pzs bool
Output only. This boolean field is only set for projects that have Physical Zone Separation enabled via an Org Policy constraint. It is set to true when the corpus is a valid zone separated corpus and false if it isn't. This field is a member of oneof_ _satisfies_pzs.
satisfies_pzi bool
Output only. This boolean field is only set for projects that have Physical Zone Isolation enabled via an Org Policy constraint. It is set to true when the corpus is a valid zone isolated corpus and false if it isn't. This field is a member of oneof_ _satisfies_pzi.

Classes

Type

Type(value)

Type of the asset inside the corpus.