Class TextExtractionPredictionResult (3.8.0)

public final class TextExtractionPredictionResult extends GeneratedMessageV3 implements TextExtractionPredictionResultOrBuilder

Prediction output format for Text Extraction.

Protobuf type google.cloud.aiplatform.v1.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
TypeDescription
int

DISPLAY_NAMES_FIELD_NUMBER

public static final int DISPLAY_NAMES_FIELD_NUMBER
Field Value
TypeDescription
int

IDS_FIELD_NUMBER

public static final int IDS_FIELD_NUMBER
Field Value
TypeDescription
int

TEXT_SEGMENT_END_OFFSETS_FIELD_NUMBER

public static final int TEXT_SEGMENT_END_OFFSETS_FIELD_NUMBER
Field Value
TypeDescription
int

TEXT_SEGMENT_START_OFFSETS_FIELD_NUMBER

public static final int TEXT_SEGMENT_START_OFFSETS_FIELD_NUMBER
Field Value
TypeDescription
int

Static Methods

getDefaultInstance()

public static TextExtractionPredictionResult getDefaultInstance()
Returns
TypeDescription
TextExtractionPredictionResult

getDescriptor()

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

newBuilder()

public static TextExtractionPredictionResult.Builder newBuilder()
Returns
TypeDescription
TextExtractionPredictionResult.Builder

newBuilder(TextExtractionPredictionResult prototype)

public static TextExtractionPredictionResult.Builder newBuilder(TextExtractionPredictionResult prototype)
Parameter
NameDescription
prototypeTextExtractionPredictionResult
Returns
TypeDescription
TextExtractionPredictionResult.Builder

parseDelimitedFrom(InputStream input)

public static TextExtractionPredictionResult parseDelimitedFrom(InputStream input)
Parameter
NameDescription
inputInputStream
Returns
TypeDescription
TextExtractionPredictionResult
Exceptions
TypeDescription
IOException

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static TextExtractionPredictionResult parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
TextExtractionPredictionResult
Exceptions
TypeDescription
IOException

parseFrom(byte[] data)

public static TextExtractionPredictionResult parseFrom(byte[] data)
Parameter
NameDescription
databyte[]
Returns
TypeDescription
TextExtractionPredictionResult
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

public static TextExtractionPredictionResult parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
databyte[]
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
TextExtractionPredictionResult
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(ByteString data)

public static TextExtractionPredictionResult parseFrom(ByteString data)
Parameter
NameDescription
dataByteString
Returns
TypeDescription
TextExtractionPredictionResult
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

public static TextExtractionPredictionResult parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
dataByteString
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
TextExtractionPredictionResult
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(CodedInputStream input)

public static TextExtractionPredictionResult parseFrom(CodedInputStream input)
Parameter
NameDescription
inputCodedInputStream
Returns
TypeDescription
TextExtractionPredictionResult
Exceptions
TypeDescription
IOException

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public static TextExtractionPredictionResult parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputCodedInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
TextExtractionPredictionResult
Exceptions
TypeDescription
IOException

parseFrom(InputStream input)

public static TextExtractionPredictionResult parseFrom(InputStream input)
Parameter
NameDescription
inputInputStream
Returns
TypeDescription
TextExtractionPredictionResult
Exceptions
TypeDescription
IOException

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static TextExtractionPredictionResult parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
TextExtractionPredictionResult
Exceptions
TypeDescription
IOException

parseFrom(ByteBuffer data)

public static TextExtractionPredictionResult parseFrom(ByteBuffer data)
Parameter
NameDescription
dataByteBuffer
Returns
TypeDescription
TextExtractionPredictionResult
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

public static TextExtractionPredictionResult parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
dataByteBuffer
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
TextExtractionPredictionResult
Exceptions
TypeDescription
InvalidProtocolBufferException

parser()

public static Parser<TextExtractionPredictionResult> parser()
Returns
TypeDescription
Parser<TextExtractionPredictionResult>

Methods

equals(Object obj)

public boolean equals(Object obj)
Parameter
NameDescription
objObject
Returns
TypeDescription
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
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

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.

getParserForType()

public Parser<TextExtractionPredictionResult> getParserForType()
Returns
TypeDescription
Parser<TextExtractionPredictionResult>
Overrides

getSerializedSize()

public int getSerializedSize()
Returns
TypeDescription
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
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.

getUnknownFields()

public final UnknownFieldSet getUnknownFields()
Returns
TypeDescription
UnknownFieldSet
Overrides

hashCode()

public int hashCode()
Returns
TypeDescription
int
Overrides

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
TypeDescription
FieldAccessorTable
Overrides

isInitialized()

public final boolean isInitialized()
Returns
TypeDescription
boolean
Overrides

newBuilderForType()

public TextExtractionPredictionResult.Builder newBuilderForType()
Returns
TypeDescription
TextExtractionPredictionResult.Builder

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

protected TextExtractionPredictionResult.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Parameter
NameDescription
parentBuilderParent
Returns
TypeDescription
TextExtractionPredictionResult.Builder
Overrides

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Parameter
NameDescription
unusedUnusedPrivateParameter
Returns
TypeDescription
Object
Overrides

toBuilder()

public TextExtractionPredictionResult.Builder toBuilder()
Returns
TypeDescription
TextExtractionPredictionResult.Builder

writeTo(CodedOutputStream output)

public void writeTo(CodedOutputStream output)
Parameter
NameDescription
outputCodedOutputStream
Overrides Exceptions
TypeDescription
IOException