Class TextExtractionPredictionResult.Builder (3.31.0)

public static final class TextExtractionPredictionResult.Builder extends GeneratedMessageV3.Builder<TextExtractionPredictionResult.Builder> implements TextExtractionPredictionResultOrBuilder

Prediction output format for Text Extraction.

Protobuf type google.cloud.aiplatform.v1beta1.schema.predict.prediction.TextExtractionPredictionResult

Static Methods

getDescriptor()

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

Methods

addAllConfidences(Iterable<? extends Float> values)

public TextExtractionPredictionResult.Builder addAllConfidences(Iterable<? extends Float> values)

The Model's confidences in correctness of the predicted IDs, higher value means higher confidence. Order matches the Ids.

repeated float confidences = 5;

Parameter
NameDescription
valuesIterable<? extends java.lang.Float>

The confidences to add.

Returns
TypeDescription
TextExtractionPredictionResult.Builder

This builder for chaining.

addAllDisplayNames(Iterable<String> values)

public TextExtractionPredictionResult.Builder addAllDisplayNames(Iterable<String> values)

The display names of the AnnotationSpecs that had been identified, order matches the IDs.

repeated string display_names = 2;

Parameter
NameDescription
valuesIterable<String>

The displayNames to add.

Returns
TypeDescription
TextExtractionPredictionResult.Builder

This builder for chaining.

addAllIds(Iterable<? extends Long> values)

public TextExtractionPredictionResult.Builder addAllIds(Iterable<? extends Long> values)

The resource IDs of the AnnotationSpecs that had been identified, ordered by the confidence score descendingly.

repeated int64 ids = 1;

Parameter
NameDescription
valuesIterable<? extends java.lang.Long>

The ids to add.

Returns
TypeDescription
TextExtractionPredictionResult.Builder

This builder for chaining.

addAllTextSegmentEndOffsets(Iterable<? extends Long> values)

public TextExtractionPredictionResult.Builder addAllTextSegmentEndOffsets(Iterable<? extends Long> values)

The end offsets, inclusive, of the text segment in which the AnnotationSpec has been identified. Expressed as a zero-based number of characters as measured from the start of the text snippet.

repeated int64 text_segment_end_offsets = 4;

Parameter
NameDescription
valuesIterable<? extends java.lang.Long>

The textSegmentEndOffsets to add.

Returns
TypeDescription
TextExtractionPredictionResult.Builder

This builder for chaining.

addAllTextSegmentStartOffsets(Iterable<? extends Long> values)

public TextExtractionPredictionResult.Builder addAllTextSegmentStartOffsets(Iterable<? extends Long> values)

The start offsets, inclusive, of the text segment in which the AnnotationSpec has been identified. Expressed as a zero-based number of characters as measured from the start of the text snippet.

repeated int64 text_segment_start_offsets = 3;

Parameter
NameDescription
valuesIterable<? extends java.lang.Long>

The textSegmentStartOffsets to add.

Returns
TypeDescription
TextExtractionPredictionResult.Builder

This builder for chaining.

addConfidences(float value)

public TextExtractionPredictionResult.Builder addConfidences(float value)

The Model's confidences in correctness of the predicted IDs, higher value means higher confidence. Order matches the Ids.

repeated float confidences = 5;

Parameter
NameDescription
valuefloat

The confidences to add.

Returns
TypeDescription
TextExtractionPredictionResult.Builder

This builder for chaining.

addDisplayNames(String value)

public TextExtractionPredictionResult.Builder addDisplayNames(String value)

The display names of the AnnotationSpecs that had been identified, order matches the IDs.

repeated string display_names = 2;

Parameter
NameDescription
valueString

The displayNames to add.

Returns
TypeDescription
TextExtractionPredictionResult.Builder

This builder for chaining.

addDisplayNamesBytes(ByteString value)

public TextExtractionPredictionResult.Builder addDisplayNamesBytes(ByteString value)

The display names of the AnnotationSpecs that had been identified, order matches the IDs.

repeated string display_names = 2;

Parameter
NameDescription
valueByteString

The bytes of the displayNames to add.

Returns
TypeDescription
TextExtractionPredictionResult.Builder

This builder for chaining.

addIds(long value)

public TextExtractionPredictionResult.Builder addIds(long value)

The resource IDs of the AnnotationSpecs that had been identified, ordered by the confidence score descendingly.

repeated int64 ids = 1;

Parameter
NameDescription
valuelong

The ids to add.

Returns
TypeDescription
TextExtractionPredictionResult.Builder

This builder for chaining.

addRepeatedField(Descriptors.FieldDescriptor field, Object value)

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

addTextSegmentEndOffsets(long value)

public TextExtractionPredictionResult.Builder addTextSegmentEndOffsets(long value)

The end offsets, inclusive, of the text segment in which the AnnotationSpec has been identified. Expressed as a zero-based number of characters as measured from the start of the text snippet.

repeated int64 text_segment_end_offsets = 4;

Parameter
NameDescription
valuelong

The textSegmentEndOffsets to add.

Returns
TypeDescription
TextExtractionPredictionResult.Builder

This builder for chaining.

addTextSegmentStartOffsets(long value)

public TextExtractionPredictionResult.Builder addTextSegmentStartOffsets(long value)

The start offsets, inclusive, of the text segment in which the AnnotationSpec has been identified. Expressed as a zero-based number of characters as measured from the start of the text snippet.

repeated int64 text_segment_start_offsets = 3;

Parameter
NameDescription
valuelong

The textSegmentStartOffsets to add.

Returns
TypeDescription
TextExtractionPredictionResult.Builder

This builder for chaining.

build()

public TextExtractionPredictionResult build()
Returns
TypeDescription
TextExtractionPredictionResult

buildPartial()

public TextExtractionPredictionResult buildPartial()
Returns
TypeDescription
TextExtractionPredictionResult

clear()

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

clearConfidences()

public TextExtractionPredictionResult.Builder clearConfidences()

The Model's confidences in correctness of the predicted IDs, higher value means higher confidence. Order matches the Ids.

repeated float confidences = 5;

Returns
TypeDescription
TextExtractionPredictionResult.Builder

This builder for chaining.

clearDisplayNames()

public TextExtractionPredictionResult.Builder clearDisplayNames()

The display names of the AnnotationSpecs that had been identified, order matches the IDs.

repeated string display_names = 2;

Returns
TypeDescription
TextExtractionPredictionResult.Builder

This builder for chaining.

clearField(Descriptors.FieldDescriptor field)

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

clearIds()

public TextExtractionPredictionResult.Builder clearIds()

The resource IDs of the AnnotationSpecs that had been identified, ordered by the confidence score descendingly.

repeated int64 ids = 1;

Returns
TypeDescription
TextExtractionPredictionResult.Builder

This builder for chaining.

clearOneof(Descriptors.OneofDescriptor oneof)

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

clearTextSegmentEndOffsets()

public TextExtractionPredictionResult.Builder clearTextSegmentEndOffsets()

The end offsets, inclusive, of the text segment in which the AnnotationSpec has been identified. Expressed as a zero-based number of characters as measured from the start of the text snippet.

repeated int64 text_segment_end_offsets = 4;

Returns
TypeDescription
TextExtractionPredictionResult.Builder

This builder for chaining.

clearTextSegmentStartOffsets()

public TextExtractionPredictionResult.Builder clearTextSegmentStartOffsets()

The start offsets, inclusive, of the text segment in which the AnnotationSpec has been identified. Expressed as a zero-based number of characters as measured from the start of the text snippet.

repeated int64 text_segment_start_offsets = 3;

Returns
TypeDescription
TextExtractionPredictionResult.Builder

This builder for chaining.

clone()

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

getConfidences(int index)

public float getConfidences(int index)

The Model's confidences in correctness of the predicted IDs, higher value means higher confidence. Order matches the Ids.

repeated float confidences = 5;

Parameter
NameDescription
indexint

The index of the element to return.

Returns
TypeDescription
float

The confidences at the given index.

getConfidencesCount()

public int getConfidencesCount()

The Model's confidences in correctness of the predicted IDs, higher value means higher confidence. Order matches the Ids.

repeated float confidences = 5;

Returns
TypeDescription
int

The count of confidences.

getConfidencesList()

public List<Float> getConfidencesList()

The Model's confidences in correctness of the predicted IDs, higher value means higher confidence. Order matches the Ids.

repeated float confidences = 5;

Returns
TypeDescription
List<Float>

A list containing the confidences.

getDefaultInstanceForType()

public TextExtractionPredictionResult getDefaultInstanceForType()
Returns
TypeDescription
TextExtractionPredictionResult

getDescriptorForType()

public Descriptors.Descriptor getDescriptorForType()
Returns
TypeDescription
Descriptor
Overrides

getDisplayNames(int index)

public String getDisplayNames(int index)

The display names of the AnnotationSpecs that had been identified, order matches the IDs.

repeated string display_names = 2;

Parameter
NameDescription
indexint

The index of the element to return.

Returns
TypeDescription
String

The displayNames at the given index.

getDisplayNamesBytes(int index)

public ByteString getDisplayNamesBytes(int index)

The display names of the AnnotationSpecs that had been identified, order matches the IDs.

repeated string display_names = 2;

Parameter
NameDescription
indexint

The index of the value to return.

Returns
TypeDescription
ByteString

The bytes of the displayNames at the given index.

getDisplayNamesCount()

public int getDisplayNamesCount()

The display names of the AnnotationSpecs that had been identified, order matches the IDs.

repeated string display_names = 2;

Returns
TypeDescription
int

The count of displayNames.

getDisplayNamesList()

public ProtocolStringList getDisplayNamesList()

The display names of the AnnotationSpecs that had been identified, order matches the IDs.

repeated string display_names = 2;

Returns
TypeDescription
ProtocolStringList

A list containing the displayNames.

getIds(int index)

public long getIds(int index)

The resource IDs of the AnnotationSpecs that had been identified, ordered by the confidence score descendingly.

repeated int64 ids = 1;

Parameter
NameDescription
indexint

The index of the element to return.

Returns
TypeDescription
long

The ids at the given index.

getIdsCount()

public int getIdsCount()

The resource IDs of the AnnotationSpecs that had been identified, ordered by the confidence score descendingly.

repeated int64 ids = 1;

Returns
TypeDescription
int

The count of ids.

getIdsList()

public List<Long> getIdsList()

The resource IDs of the AnnotationSpecs that had been identified, ordered by the confidence score descendingly.

repeated int64 ids = 1;

Returns
TypeDescription
List<Long>

A list containing the ids.

getTextSegmentEndOffsets(int index)

public long getTextSegmentEndOffsets(int index)

The end offsets, inclusive, of the text segment in which the AnnotationSpec has been identified. Expressed as a zero-based number of characters as measured from the start of the text snippet.

repeated int64 text_segment_end_offsets = 4;

Parameter
NameDescription
indexint

The index of the element to return.

Returns
TypeDescription
long

The textSegmentEndOffsets at the given index.

getTextSegmentEndOffsetsCount()

public int getTextSegmentEndOffsetsCount()

The end offsets, inclusive, of the text segment in which the AnnotationSpec has been identified. Expressed as a zero-based number of characters as measured from the start of the text snippet.

repeated int64 text_segment_end_offsets = 4;

Returns
TypeDescription
int

The count of textSegmentEndOffsets.

getTextSegmentEndOffsetsList()

public List<Long> getTextSegmentEndOffsetsList()

The end offsets, inclusive, of the text segment in which the AnnotationSpec has been identified. Expressed as a zero-based number of characters as measured from the start of the text snippet.

repeated int64 text_segment_end_offsets = 4;

Returns
TypeDescription
List<Long>

A list containing the textSegmentEndOffsets.

getTextSegmentStartOffsets(int index)

public long getTextSegmentStartOffsets(int index)

The start offsets, inclusive, of the text segment in which the AnnotationSpec has been identified. Expressed as a zero-based number of characters as measured from the start of the text snippet.

repeated int64 text_segment_start_offsets = 3;

Parameter
NameDescription
indexint

The index of the element to return.

Returns
TypeDescription
long

The textSegmentStartOffsets at the given index.

getTextSegmentStartOffsetsCount()

public int getTextSegmentStartOffsetsCount()

The start offsets, inclusive, of the text segment in which the AnnotationSpec has been identified. Expressed as a zero-based number of characters as measured from the start of the text snippet.

repeated int64 text_segment_start_offsets = 3;

Returns
TypeDescription
int

The count of textSegmentStartOffsets.

getTextSegmentStartOffsetsList()

public List<Long> getTextSegmentStartOffsetsList()

The start offsets, inclusive, of the text segment in which the AnnotationSpec has been identified. Expressed as a zero-based number of characters as measured from the start of the text snippet.

repeated int64 text_segment_start_offsets = 3;

Returns
TypeDescription
List<Long>

A list containing the textSegmentStartOffsets.

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
TypeDescription
FieldAccessorTable
Overrides

isInitialized()

public final boolean isInitialized()
Returns
TypeDescription
boolean
Overrides

mergeFrom(TextExtractionPredictionResult other)

public TextExtractionPredictionResult.Builder mergeFrom(TextExtractionPredictionResult other)
Parameter
NameDescription
otherTextExtractionPredictionResult
Returns
TypeDescription
TextExtractionPredictionResult.Builder

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

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

mergeFrom(Message other)

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

mergeUnknownFields(UnknownFieldSet unknownFields)

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

setConfidences(int index, float value)

public TextExtractionPredictionResult.Builder setConfidences(int index, float value)

The Model's confidences in correctness of the predicted IDs, higher value means higher confidence. Order matches the Ids.

repeated float confidences = 5;

Parameters
NameDescription
indexint

The index to set the value at.

valuefloat

The confidences to set.

Returns
TypeDescription
TextExtractionPredictionResult.Builder

This builder for chaining.

setDisplayNames(int index, String value)

public TextExtractionPredictionResult.Builder setDisplayNames(int index, String value)

The display names of the AnnotationSpecs that had been identified, order matches the IDs.

repeated string display_names = 2;

Parameters
NameDescription
indexint

The index to set the value at.

valueString

The displayNames to set.

Returns
TypeDescription
TextExtractionPredictionResult.Builder

This builder for chaining.

setField(Descriptors.FieldDescriptor field, Object value)

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

setIds(int index, long value)

public TextExtractionPredictionResult.Builder setIds(int index, long value)

The resource IDs of the AnnotationSpecs that had been identified, ordered by the confidence score descendingly.

repeated int64 ids = 1;

Parameters
NameDescription
indexint

The index to set the value at.

valuelong

The ids to set.

Returns
TypeDescription
TextExtractionPredictionResult.Builder

This builder for chaining.

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

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

setTextSegmentEndOffsets(int index, long value)

public TextExtractionPredictionResult.Builder setTextSegmentEndOffsets(int index, long value)

The end offsets, inclusive, of the text segment in which the AnnotationSpec has been identified. Expressed as a zero-based number of characters as measured from the start of the text snippet.

repeated int64 text_segment_end_offsets = 4;

Parameters
NameDescription
indexint

The index to set the value at.

valuelong

The textSegmentEndOffsets to set.

Returns
TypeDescription
TextExtractionPredictionResult.Builder

This builder for chaining.

setTextSegmentStartOffsets(int index, long value)

public TextExtractionPredictionResult.Builder setTextSegmentStartOffsets(int index, long value)

The start offsets, inclusive, of the text segment in which the AnnotationSpec has been identified. Expressed as a zero-based number of characters as measured from the start of the text snippet.

repeated int64 text_segment_start_offsets = 3;

Parameters
NameDescription
indexint

The index to set the value at.

valuelong

The textSegmentStartOffsets to set.

Returns
TypeDescription
TextExtractionPredictionResult.Builder

This builder for chaining.

setUnknownFields(UnknownFieldSet unknownFields)

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