Class TextExtractionPredictionResult (3.42.0)

public final class TextExtractionPredictionResult extends GeneratedMessageV3 implements TextExtractionPredictionResultOrBuilder

Prediction output format for Text Extraction.

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

Inheritance

Object > AbstractMessageLite<MessageType,BuilderType> > AbstractMessage > GeneratedMessageV3 > TextExtractionPredictionResult

Static Fields

CONFIDENCES_FIELD_NUMBER

public static final int CONFIDENCES_FIELD_NUMBER
Field Value
Type Description
int

DISPLAY_NAMES_FIELD_NUMBER

public static final int DISPLAY_NAMES_FIELD_NUMBER
Field Value
Type Description
int

IDS_FIELD_NUMBER

public static final int IDS_FIELD_NUMBER
Field Value
Type Description
int

TEXT_SEGMENT_END_OFFSETS_FIELD_NUMBER

public static final int TEXT_SEGMENT_END_OFFSETS_FIELD_NUMBER
Field Value
Type Description
int

TEXT_SEGMENT_START_OFFSETS_FIELD_NUMBER

public static final int TEXT_SEGMENT_START_OFFSETS_FIELD_NUMBER
Field Value
Type Description
int

Static Methods

getDefaultInstance()

public static TextExtractionPredictionResult getDefaultInstance()
Returns
Type Description
TextExtractionPredictionResult

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()
Returns
Type Description
Descriptor

newBuilder()

public static TextExtractionPredictionResult.Builder newBuilder()
Returns
Type Description
TextExtractionPredictionResult.Builder

newBuilder(TextExtractionPredictionResult prototype)

public static TextExtractionPredictionResult.Builder newBuilder(TextExtractionPredictionResult prototype)
Parameter
Name Description
prototype TextExtractionPredictionResult
Returns
Type Description
TextExtractionPredictionResult.Builder

parseDelimitedFrom(InputStream input)

public static TextExtractionPredictionResult parseDelimitedFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
TextExtractionPredictionResult
Exceptions
Type Description
IOException

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static TextExtractionPredictionResult parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
TextExtractionPredictionResult
Exceptions
Type Description
IOException

parseFrom(byte[] data)

public static TextExtractionPredictionResult parseFrom(byte[] data)
Parameter
Name Description
data byte[]
Returns
Type Description
TextExtractionPredictionResult
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

public static TextExtractionPredictionResult parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data byte[]
extensionRegistry ExtensionRegistryLite
Returns
Type Description
TextExtractionPredictionResult
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data)

public static TextExtractionPredictionResult parseFrom(ByteString data)
Parameter
Name Description
data ByteString
Returns
Type Description
TextExtractionPredictionResult
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

public static TextExtractionPredictionResult parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data ByteString
extensionRegistry ExtensionRegistryLite
Returns
Type Description
TextExtractionPredictionResult
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(CodedInputStream input)

public static TextExtractionPredictionResult parseFrom(CodedInputStream input)
Parameter
Name Description
input CodedInputStream
Returns
Type Description
TextExtractionPredictionResult
Exceptions
Type Description
IOException

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public static TextExtractionPredictionResult parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input CodedInputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
TextExtractionPredictionResult
Exceptions
Type Description
IOException

parseFrom(InputStream input)

public static TextExtractionPredictionResult parseFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
TextExtractionPredictionResult
Exceptions
Type Description
IOException

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static TextExtractionPredictionResult parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
TextExtractionPredictionResult
Exceptions
Type Description
IOException

parseFrom(ByteBuffer data)

public static TextExtractionPredictionResult parseFrom(ByteBuffer data)
Parameter
Name Description
data ByteBuffer
Returns
Type Description
TextExtractionPredictionResult
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

public static TextExtractionPredictionResult parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data ByteBuffer
extensionRegistry ExtensionRegistryLite
Returns
Type Description
TextExtractionPredictionResult
Exceptions
Type Description
InvalidProtocolBufferException

parser()

public static Parser<TextExtractionPredictionResult> parser()
Returns
Type Description
Parser<TextExtractionPredictionResult>

Methods

equals(Object obj)

public boolean equals(Object obj)
Parameter
Name Description
obj Object
Returns
Type Description
boolean
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
Name Description
index int

The index of the element to return.

Returns
Type Description
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
Type Description
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
Type Description
List<Float>

A list containing the confidences.

getDefaultInstanceForType()

public TextExtractionPredictionResult getDefaultInstanceForType()
Returns
Type Description
TextExtractionPredictionResult

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
Name Description
index int

The index of the element to return.

Returns
Type Description
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
Name Description
index int

The index of the value to return.

Returns
Type Description
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
Type Description
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
Type Description
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
Name Description
index int

The index of the element to return.

Returns
Type Description
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
Type Description
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
Type Description
List<Long>

A list containing the ids.

getParserForType()

public Parser<TextExtractionPredictionResult> getParserForType()
Returns
Type Description
Parser<TextExtractionPredictionResult>
Overrides

getSerializedSize()

public int getSerializedSize()
Returns
Type Description
int
Overrides

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
Name Description
index int

The index of the element to return.

Returns
Type Description
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
Type Description
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
Type Description
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
Name Description
index int

The index of the element to return.

Returns
Type Description
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
Type Description
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
Type Description
List<Long>

A list containing the textSegmentStartOffsets.

hashCode()

public int hashCode()
Returns
Type Description
int
Overrides

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
Type Description
FieldAccessorTable
Overrides

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

newBuilderForType()

public TextExtractionPredictionResult.Builder newBuilderForType()
Returns
Type Description
TextExtractionPredictionResult.Builder

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

protected TextExtractionPredictionResult.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Parameter
Name Description
parent BuilderParent
Returns
Type Description
TextExtractionPredictionResult.Builder
Overrides

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Parameter
Name Description
unused UnusedPrivateParameter
Returns
Type Description
Object
Overrides

toBuilder()

public TextExtractionPredictionResult.Builder toBuilder()
Returns
Type Description
TextExtractionPredictionResult.Builder

writeTo(CodedOutputStream output)

public void writeTo(CodedOutputStream output)
Parameter
Name Description
output CodedOutputStream
Overrides
Exceptions
Type Description
IOException