Class TextExtractionPredictionResult

  • All Implemented Interfaces:
    TextExtractionPredictionResultOrBuilder, com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Serializable

    public final class TextExtractionPredictionResult
    extends com.google.protobuf.GeneratedMessageV3
    implements TextExtractionPredictionResultOrBuilder
     Prediction output format for Text Extraction.
     
    Protobuf type google.cloud.aiplatform.v1.schema.predict.prediction.TextExtractionPredictionResult
    See Also:
    Serialized Form
    • Field Detail

      • DISPLAY_NAMES_FIELD_NUMBER

        public static final int DISPLAY_NAMES_FIELD_NUMBER
        See Also:
        Constant Field Values
      • TEXT_SEGMENT_START_OFFSETS_FIELD_NUMBER

        public static final int TEXT_SEGMENT_START_OFFSETS_FIELD_NUMBER
        See Also:
        Constant Field Values
      • TEXT_SEGMENT_END_OFFSETS_FIELD_NUMBER

        public static final int TEXT_SEGMENT_END_OFFSETS_FIELD_NUMBER
        See Also:
        Constant Field Values
      • CONFIDENCES_FIELD_NUMBER

        public static final int CONFIDENCES_FIELD_NUMBER
        See Also:
        Constant Field Values
    • Method Detail

      • newInstance

        protected Object newInstance​(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused)
        Overrides:
        newInstance in class com.google.protobuf.GeneratedMessageV3
      • getDescriptor

        public static final com.google.protobuf.Descriptors.Descriptor getDescriptor()
      • internalGetFieldAccessorTable

        protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
        Specified by:
        internalGetFieldAccessorTable in class com.google.protobuf.GeneratedMessageV3
      • 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;
        Specified by:
        getIdsList in interface TextExtractionPredictionResultOrBuilder
        Returns:
        A list containing the ids.
      • getIdsCount

        public int getIdsCount()
         The resource IDs of the AnnotationSpecs that had been identified,
         ordered by the confidence score descendingly.
         
        repeated int64 ids = 1;
        Specified by:
        getIdsCount in interface TextExtractionPredictionResultOrBuilder
        Returns:
        The count of ids.
      • getIds

        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;
        Specified by:
        getIds in interface TextExtractionPredictionResultOrBuilder
        Parameters:
        index - The index of the element to return.
        Returns:
        The ids at the given index.
      • getDisplayNamesList

        public com.google.protobuf.ProtocolStringList getDisplayNamesList()
         The display names of the AnnotationSpecs that had been identified,
         order matches the IDs.
         
        repeated string display_names = 2;
        Specified by:
        getDisplayNamesList in interface TextExtractionPredictionResultOrBuilder
        Returns:
        A list containing the displayNames.
      • getDisplayNamesCount

        public int getDisplayNamesCount()
         The display names of the AnnotationSpecs that had been identified,
         order matches the IDs.
         
        repeated string display_names = 2;
        Specified by:
        getDisplayNamesCount in interface TextExtractionPredictionResultOrBuilder
        Returns:
        The count of displayNames.
      • getDisplayNames

        public String getDisplayNames​(int index)
         The display names of the AnnotationSpecs that had been identified,
         order matches the IDs.
         
        repeated string display_names = 2;
        Specified by:
        getDisplayNames in interface TextExtractionPredictionResultOrBuilder
        Parameters:
        index - The index of the element to return.
        Returns:
        The displayNames at the given index.
      • getDisplayNamesBytes

        public com.google.protobuf.ByteString getDisplayNamesBytes​(int index)
         The display names of the AnnotationSpecs that had been identified,
         order matches the IDs.
         
        repeated string display_names = 2;
        Specified by:
        getDisplayNamesBytes in interface TextExtractionPredictionResultOrBuilder
        Parameters:
        index - The index of the value to return.
        Returns:
        The bytes of the displayNames at the given index.
      • 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;
        Specified by:
        getTextSegmentStartOffsetsList in interface TextExtractionPredictionResultOrBuilder
        Returns:
        A list containing the textSegmentStartOffsets.
      • 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;
        Specified by:
        getTextSegmentStartOffsetsCount in interface TextExtractionPredictionResultOrBuilder
        Returns:
        The count of textSegmentStartOffsets.
      • getTextSegmentStartOffsets

        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;
        Specified by:
        getTextSegmentStartOffsets in interface TextExtractionPredictionResultOrBuilder
        Parameters:
        index - The index of the element to return.
        Returns:
        The textSegmentStartOffsets at the given index.
      • 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;
        Specified by:
        getTextSegmentEndOffsetsList in interface TextExtractionPredictionResultOrBuilder
        Returns:
        A list containing the textSegmentEndOffsets.
      • 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;
        Specified by:
        getTextSegmentEndOffsetsCount in interface TextExtractionPredictionResultOrBuilder
        Returns:
        The count of textSegmentEndOffsets.
      • getTextSegmentEndOffsets

        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;
        Specified by:
        getTextSegmentEndOffsets in interface TextExtractionPredictionResultOrBuilder
        Parameters:
        index - The index of the element to return.
        Returns:
        The textSegmentEndOffsets at the given index.
      • 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;
        Specified by:
        getConfidencesList in interface TextExtractionPredictionResultOrBuilder
        Returns:
        A list containing the confidences.
      • 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;
        Specified by:
        getConfidencesCount in interface TextExtractionPredictionResultOrBuilder
        Returns:
        The count of confidences.
      • getConfidences

        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;
        Specified by:
        getConfidences in interface TextExtractionPredictionResultOrBuilder
        Parameters:
        index - The index of the element to return.
        Returns:
        The confidences at the given index.
      • isInitialized

        public final boolean isInitialized()
        Specified by:
        isInitialized in interface com.google.protobuf.MessageLiteOrBuilder
        Overrides:
        isInitialized in class com.google.protobuf.GeneratedMessageV3
      • writeTo

        public void writeTo​(com.google.protobuf.CodedOutputStream output)
                     throws IOException
        Specified by:
        writeTo in interface com.google.protobuf.MessageLite
        Overrides:
        writeTo in class com.google.protobuf.GeneratedMessageV3
        Throws:
        IOException
      • getSerializedSize

        public int getSerializedSize()
        Specified by:
        getSerializedSize in interface com.google.protobuf.MessageLite
        Overrides:
        getSerializedSize in class com.google.protobuf.GeneratedMessageV3
      • equals

        public boolean equals​(Object obj)
        Specified by:
        equals in interface com.google.protobuf.Message
        Overrides:
        equals in class com.google.protobuf.AbstractMessage
      • hashCode

        public int hashCode()
        Specified by:
        hashCode in interface com.google.protobuf.Message
        Overrides:
        hashCode in class com.google.protobuf.AbstractMessage
      • parseFrom

        public static TextExtractionPredictionResult parseFrom​(ByteBuffer data)
                                                        throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException
      • parseFrom

        public static TextExtractionPredictionResult parseFrom​(ByteBuffer data,
                                                               com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                                        throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException
      • parseFrom

        public static TextExtractionPredictionResult parseFrom​(com.google.protobuf.ByteString data)
                                                        throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException
      • parseFrom

        public static TextExtractionPredictionResult parseFrom​(com.google.protobuf.ByteString data,
                                                               com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                                        throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException
      • parseFrom

        public static TextExtractionPredictionResult parseFrom​(byte[] data)
                                                        throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException
      • parseFrom

        public static TextExtractionPredictionResult parseFrom​(byte[] data,
                                                               com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                                        throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException
      • newBuilderForType

        public TextExtractionPredictionResult.Builder newBuilderForType()
        Specified by:
        newBuilderForType in interface com.google.protobuf.Message
        Specified by:
        newBuilderForType in interface com.google.protobuf.MessageLite
      • toBuilder

        public TextExtractionPredictionResult.Builder toBuilder()
        Specified by:
        toBuilder in interface com.google.protobuf.Message
        Specified by:
        toBuilder in interface com.google.protobuf.MessageLite
      • newBuilderForType

        protected TextExtractionPredictionResult.Builder newBuilderForType​(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)
        Specified by:
        newBuilderForType in class com.google.protobuf.GeneratedMessageV3
      • getParserForType

        public com.google.protobuf.Parser<TextExtractionPredictionResult> getParserForType()
        Specified by:
        getParserForType in interface com.google.protobuf.Message
        Specified by:
        getParserForType in interface com.google.protobuf.MessageLite
        Overrides:
        getParserForType in class com.google.protobuf.GeneratedMessageV3
      • getDefaultInstanceForType

        public TextExtractionPredictionResult getDefaultInstanceForType()
        Specified by:
        getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder
        Specified by:
        getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder