Vision AI v1 API - Class Corpus (1.0.0-beta01)

public sealed class Corpus : IMessage<Corpus>, IEquatable<Corpus>, IDeepCloneable<Corpus>, IBufferMessage, IMessage

Reference documentation and code samples for the Vision AI v1 API class Corpus.

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.

Inheritance

object > Corpus

Namespace

Google.Cloud.VisionAI.V1

Assembly

Google.Cloud.VisionAI.V1.dll

Constructors

Corpus()

public Corpus()

Corpus(Corpus)

public Corpus(Corpus other)
Parameter
Name Description
other Corpus

Properties

CorpusName

public CorpusName CorpusName { get; set; }

CorpusName-typed view over the Name resource name property.

Property Value
Type Description
CorpusName

DefaultTtl

public Duration DefaultTtl { get; set; }

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.

Property Value
Type Description
Duration

Description

public string Description { get; set; }

Optional. Description of the corpus. Can be up to 25000 characters long.

Property Value
Type Description
string

DisplayName

public string DisplayName { get; set; }

Required. The corpus name to shown in the UI. The name can be up to 32 characters long.

Property Value
Type Description
string

HasSatisfiesPzi

public bool HasSatisfiesPzi { get; }

Gets whether the "satisfies_pzi" field is set

Property Value
Type Description
bool

HasSatisfiesPzs

public bool HasSatisfiesPzs { get; }

Gets whether the "satisfies_pzs" field is set

Property Value
Type Description
bool

Name

public string Name { get; set; }

Resource name of the corpus. Format: projects/{project_number}/locations/{location_id}/corpora/{corpus_id}

Property Value
Type Description
string

SatisfiesPzi

public bool SatisfiesPzi { get; set; }

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.

Property Value
Type Description
bool

SatisfiesPzs

public bool SatisfiesPzs { get; set; }

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.

Property Value
Type Description
bool

SearchCapabilitySetting

public SearchCapabilitySetting SearchCapabilitySetting { get; set; }

Default search capability setting on corpus level.

Property Value
Type Description
SearchCapabilitySetting

Type

public Corpus.Types.Type Type { get; set; }

Optional. Type of the asset inside corpus.

Property Value
Type Description
CorpusTypesType