Class VideoClassificationPredictionParams.Builder (3.42.0)

public static final class VideoClassificationPredictionParams.Builder extends GeneratedMessageV3.Builder<VideoClassificationPredictionParams.Builder> implements VideoClassificationPredictionParamsOrBuilder

Prediction model parameters for Video Classification.

Protobuf type google.cloud.aiplatform.v1.schema.predict.params.VideoClassificationPredictionParams

Static Methods

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()
Returns
TypeDescription
Descriptor

Methods

addRepeatedField(Descriptors.FieldDescriptor field, Object value)

public VideoClassificationPredictionParams.Builder addRepeatedField(Descriptors.FieldDescriptor field, Object value)
Parameters
NameDescription
fieldFieldDescriptor
valueObject
Returns
TypeDescription
VideoClassificationPredictionParams.Builder
Overrides

build()

public VideoClassificationPredictionParams build()
Returns
TypeDescription
VideoClassificationPredictionParams

buildPartial()

public VideoClassificationPredictionParams buildPartial()
Returns
TypeDescription
VideoClassificationPredictionParams

clear()

public VideoClassificationPredictionParams.Builder clear()
Returns
TypeDescription
VideoClassificationPredictionParams.Builder
Overrides

clearConfidenceThreshold()

public VideoClassificationPredictionParams.Builder clearConfidenceThreshold()

The Model only returns predictions with at least this confidence score. Default value is 0.0

float confidence_threshold = 1;

Returns
TypeDescription
VideoClassificationPredictionParams.Builder

This builder for chaining.

clearField(Descriptors.FieldDescriptor field)

public VideoClassificationPredictionParams.Builder clearField(Descriptors.FieldDescriptor field)
Parameter
NameDescription
fieldFieldDescriptor
Returns
TypeDescription
VideoClassificationPredictionParams.Builder
Overrides

clearMaxPredictions()

public VideoClassificationPredictionParams.Builder clearMaxPredictions()

The Model only returns up to that many top, by confidence score, predictions per instance. If this number is very high, the Model may return fewer predictions. Default value is 10,000.

int32 max_predictions = 2;

Returns
TypeDescription
VideoClassificationPredictionParams.Builder

This builder for chaining.

clearOneSecIntervalClassification()

public VideoClassificationPredictionParams.Builder clearOneSecIntervalClassification()

Set to true to request classification for a video at one-second intervals. Vertex AI returns labels and their confidence scores for each second of the entire time segment of the video that user specified in the input WARNING: Model evaluation is not done for this classification type, the quality of it depends on the training data, but there are no metrics provided to describe that quality. Default value is false

bool one_sec_interval_classification = 5;

Returns
TypeDescription
VideoClassificationPredictionParams.Builder

This builder for chaining.

clearOneof(Descriptors.OneofDescriptor oneof)

public VideoClassificationPredictionParams.Builder clearOneof(Descriptors.OneofDescriptor oneof)
Parameter
NameDescription
oneofOneofDescriptor
Returns
TypeDescription
VideoClassificationPredictionParams.Builder
Overrides

clearSegmentClassification()

public VideoClassificationPredictionParams.Builder clearSegmentClassification()

Set to true to request segment-level classification. Vertex AI returns labels and their confidence scores for the entire time segment of the video that user specified in the input instance. Default value is true

bool segment_classification = 3;

Returns
TypeDescription
VideoClassificationPredictionParams.Builder

This builder for chaining.

clearShotClassification()

public VideoClassificationPredictionParams.Builder clearShotClassification()

Set to true to request shot-level classification. Vertex AI determines the boundaries for each camera shot in the entire time segment of the video that user specified in the input instance. Vertex AI then returns labels and their confidence scores for each detected shot, along with the start and end time of the shot. WARNING: Model evaluation is not done for this classification type, the quality of it depends on the training data, but there are no metrics provided to describe that quality. Default value is false

bool shot_classification = 4;

Returns
TypeDescription
VideoClassificationPredictionParams.Builder

This builder for chaining.

clone()

public VideoClassificationPredictionParams.Builder clone()
Returns
TypeDescription
VideoClassificationPredictionParams.Builder
Overrides

getConfidenceThreshold()

public float getConfidenceThreshold()

The Model only returns predictions with at least this confidence score. Default value is 0.0

float confidence_threshold = 1;

Returns
TypeDescription
float

The confidenceThreshold.

getDefaultInstanceForType()

public VideoClassificationPredictionParams getDefaultInstanceForType()
Returns
TypeDescription
VideoClassificationPredictionParams

getDescriptorForType()

public Descriptors.Descriptor getDescriptorForType()
Returns
TypeDescription
Descriptor
Overrides

getMaxPredictions()

public int getMaxPredictions()

The Model only returns up to that many top, by confidence score, predictions per instance. If this number is very high, the Model may return fewer predictions. Default value is 10,000.

int32 max_predictions = 2;

Returns
TypeDescription
int

The maxPredictions.

getOneSecIntervalClassification()

public boolean getOneSecIntervalClassification()

Set to true to request classification for a video at one-second intervals. Vertex AI returns labels and their confidence scores for each second of the entire time segment of the video that user specified in the input WARNING: Model evaluation is not done for this classification type, the quality of it depends on the training data, but there are no metrics provided to describe that quality. Default value is false

bool one_sec_interval_classification = 5;

Returns
TypeDescription
boolean

The oneSecIntervalClassification.

getSegmentClassification()

public boolean getSegmentClassification()

Set to true to request segment-level classification. Vertex AI returns labels and their confidence scores for the entire time segment of the video that user specified in the input instance. Default value is true

bool segment_classification = 3;

Returns
TypeDescription
boolean

The segmentClassification.

getShotClassification()

public boolean getShotClassification()

Set to true to request shot-level classification. Vertex AI determines the boundaries for each camera shot in the entire time segment of the video that user specified in the input instance. Vertex AI then returns labels and their confidence scores for each detected shot, along with the start and end time of the shot. WARNING: Model evaluation is not done for this classification type, the quality of it depends on the training data, but there are no metrics provided to describe that quality. Default value is false

bool shot_classification = 4;

Returns
TypeDescription
boolean

The shotClassification.

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
TypeDescription
FieldAccessorTable
Overrides

isInitialized()

public final boolean isInitialized()
Returns
TypeDescription
boolean
Overrides

mergeFrom(VideoClassificationPredictionParams other)

public VideoClassificationPredictionParams.Builder mergeFrom(VideoClassificationPredictionParams other)
Parameter
NameDescription
otherVideoClassificationPredictionParams
Returns
TypeDescription
VideoClassificationPredictionParams.Builder

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public VideoClassificationPredictionParams.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputCodedInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
VideoClassificationPredictionParams.Builder
Overrides
Exceptions
TypeDescription
IOException

mergeFrom(Message other)

public VideoClassificationPredictionParams.Builder mergeFrom(Message other)
Parameter
NameDescription
otherMessage
Returns
TypeDescription
VideoClassificationPredictionParams.Builder
Overrides

mergeUnknownFields(UnknownFieldSet unknownFields)

public final VideoClassificationPredictionParams.Builder mergeUnknownFields(UnknownFieldSet unknownFields)
Parameter
NameDescription
unknownFieldsUnknownFieldSet
Returns
TypeDescription
VideoClassificationPredictionParams.Builder
Overrides

setConfidenceThreshold(float value)

public VideoClassificationPredictionParams.Builder setConfidenceThreshold(float value)

The Model only returns predictions with at least this confidence score. Default value is 0.0

float confidence_threshold = 1;

Parameter
NameDescription
valuefloat

The confidenceThreshold to set.

Returns
TypeDescription
VideoClassificationPredictionParams.Builder

This builder for chaining.

setField(Descriptors.FieldDescriptor field, Object value)

public VideoClassificationPredictionParams.Builder setField(Descriptors.FieldDescriptor field, Object value)
Parameters
NameDescription
fieldFieldDescriptor
valueObject
Returns
TypeDescription
VideoClassificationPredictionParams.Builder
Overrides

setMaxPredictions(int value)

public VideoClassificationPredictionParams.Builder setMaxPredictions(int value)

The Model only returns up to that many top, by confidence score, predictions per instance. If this number is very high, the Model may return fewer predictions. Default value is 10,000.

int32 max_predictions = 2;

Parameter
NameDescription
valueint

The maxPredictions to set.

Returns
TypeDescription
VideoClassificationPredictionParams.Builder

This builder for chaining.

setOneSecIntervalClassification(boolean value)

public VideoClassificationPredictionParams.Builder setOneSecIntervalClassification(boolean value)

Set to true to request classification for a video at one-second intervals. Vertex AI returns labels and their confidence scores for each second of the entire time segment of the video that user specified in the input WARNING: Model evaluation is not done for this classification type, the quality of it depends on the training data, but there are no metrics provided to describe that quality. Default value is false

bool one_sec_interval_classification = 5;

Parameter
NameDescription
valueboolean

The oneSecIntervalClassification to set.

Returns
TypeDescription
VideoClassificationPredictionParams.Builder

This builder for chaining.

setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)

public VideoClassificationPredictionParams.Builder setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)
Parameters
NameDescription
fieldFieldDescriptor
indexint
valueObject
Returns
TypeDescription
VideoClassificationPredictionParams.Builder
Overrides

setSegmentClassification(boolean value)

public VideoClassificationPredictionParams.Builder setSegmentClassification(boolean value)

Set to true to request segment-level classification. Vertex AI returns labels and their confidence scores for the entire time segment of the video that user specified in the input instance. Default value is true

bool segment_classification = 3;

Parameter
NameDescription
valueboolean

The segmentClassification to set.

Returns
TypeDescription
VideoClassificationPredictionParams.Builder

This builder for chaining.

setShotClassification(boolean value)

public VideoClassificationPredictionParams.Builder setShotClassification(boolean value)

Set to true to request shot-level classification. Vertex AI determines the boundaries for each camera shot in the entire time segment of the video that user specified in the input instance. Vertex AI then returns labels and their confidence scores for each detected shot, along with the start and end time of the shot. WARNING: Model evaluation is not done for this classification type, the quality of it depends on the training data, but there are no metrics provided to describe that quality. Default value is false

bool shot_classification = 4;

Parameter
NameDescription
valueboolean

The shotClassification to set.

Returns
TypeDescription
VideoClassificationPredictionParams.Builder

This builder for chaining.

setUnknownFields(UnknownFieldSet unknownFields)

public final VideoClassificationPredictionParams.Builder setUnknownFields(UnknownFieldSet unknownFields)
Parameter
NameDescription
unknownFieldsUnknownFieldSet
Returns
TypeDescription
VideoClassificationPredictionParams.Builder
Overrides