Package de.uni_trier.recap.arg_services.nlp.v1

Class EmbeddingModel

java.lang.Object
com.google.protobuf.AbstractMessageLite
com.google.protobuf.AbstractMessage
com.google.protobuf.GeneratedMessageV3
de.uni_trier.recap.arg_services.nlp.v1.EmbeddingModel
All Implemented Interfaces:
com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, EmbeddingModelOrBuilder, Serializable
public final class EmbeddingModel extends com.google.protobuf.GeneratedMessageV3 implements EmbeddingModelOrBuilder
 Specification of one model that is used to generate embeddings for strings.
Protobuf type arg_services.nlp.v1.EmbeddingModel
See Also:

  • Nested Class Summary

    Nested Classes
    Modifier and Type
    Class
    Description
    static final class 
    EmbeddingModel.Builder
    Specification of one model that is used to generate embeddings for strings.
    static enum 
    EmbeddingModel.PoolingCase
     

    Nested classes/interfaces inherited from class com.google.protobuf.GeneratedMessageV3

    com.google.protobuf.GeneratedMessageV3.BuilderParent, com.google.protobuf.GeneratedMessageV3.ExtendableBuilder<MessageType extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage,BuilderType extends com.google.protobuf.GeneratedMessageV3.ExtendableBuilder<MessageType,BuilderType>>, com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageType extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage>, com.google.protobuf.GeneratedMessageV3.ExtendableMessageOrBuilder<MessageType extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage>, com.google.protobuf.GeneratedMessageV3.FieldAccessorTable, com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter

    Nested classes/interfaces inherited from class com.google.protobuf.AbstractMessageLite

    com.google.protobuf.AbstractMessageLite.InternalOneOfEnum

  • Field Summary

    Fields
    Modifier and Type
    Field
    Description
    static final int
    MODEL_NAME_FIELD_NUMBER
     
    static final int
    MODEL_TYPE_FIELD_NUMBER
     
    static final int
    PMEAN_FIELD_NUMBER
     
    static final int
    POOLING_TYPE_FIELD_NUMBER
     

    Fields inherited from class com.google.protobuf.GeneratedMessageV3

    alwaysUseFieldBuilders, unknownFields

    Fields inherited from class com.google.protobuf.AbstractMessage

    memoizedSize

    Fields inherited from class com.google.protobuf.AbstractMessageLite

    memoizedHashCode

  • Method Summary

    Modifier and Type
    Method
    Description
    boolean
    equals(Object obj)
     
    static EmbeddingModel
    getDefaultInstance()
     
    EmbeddingModel
    getDefaultInstanceForType()
     
    static final com.google.protobuf.Descriptors.Descriptor
    getDescriptor()
     
    String
    getModelName()
    You have to specify the name of the model that should be used by the selected impelemtation (i.e., `model_type`).
    com.google.protobuf.ByteString
    getModelNameBytes()
    You have to specify the name of the model that should be used by the selected impelemtation (i.e., `model_type`).
    EmbeddingType
    getModelType()
    Each embedding has to be implemented, thus this enum is used to select the correct one.
    int
    getModelTypeValue()
    Each embedding has to be implemented, thus this enum is used to select the correct one.
    com.google.protobuf.Parser<EmbeddingModel>
    getParserForType()
     
    double
    getPmean()
    Power mean (or generalized mean).
    EmbeddingModel.PoolingCase
    getPoolingCase()
     
    Pooling
    getPoolingType()
    Standard pooling functions like mean, min, max.
    int
    getPoolingTypeValue()
    Standard pooling functions like mean, min, max.
    int
    getSerializedSize()
     
    final com.google.protobuf.UnknownFieldSet
    getUnknownFields()
     
    int
    hashCode()
     
    boolean
    hasPmean()
    Power mean (or generalized mean).
    boolean
    hasPoolingType()
    Standard pooling functions like mean, min, max.
    protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable
    internalGetFieldAccessorTable()
     
    final boolean
    isInitialized()
     
    static EmbeddingModel.Builder
    newBuilder()
     
    static EmbeddingModel.Builder
    newBuilder(EmbeddingModel prototype)
     
    EmbeddingModel.Builder
    newBuilderForType()
     
    protected EmbeddingModel.Builder
    newBuilderForType(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)
     
    protected Object
    newInstance(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused)
     
    static EmbeddingModel
    parseDelimitedFrom(InputStream input)
     
    static EmbeddingModel
    parseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static EmbeddingModel
    parseFrom(byte[] data)
     
    static EmbeddingModel
    parseFrom(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static EmbeddingModel
    parseFrom(com.google.protobuf.ByteString data)
     
    static EmbeddingModel
    parseFrom(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static EmbeddingModel
    parseFrom(com.google.protobuf.CodedInputStream input)
     
    static EmbeddingModel
    parseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static EmbeddingModel
    parseFrom(InputStream input)
     
    static EmbeddingModel
    parseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static EmbeddingModel
    parseFrom(ByteBuffer data)
     
    static EmbeddingModel
    parseFrom(ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static com.google.protobuf.Parser<EmbeddingModel>
    parser()
     
    EmbeddingModel.Builder
    toBuilder()
     
    void
    writeTo(com.google.protobuf.CodedOutputStream output)
     

    Methods inherited from class com.google.protobuf.GeneratedMessageV3

    canUseUnsafe, computeStringSize, computeStringSizeNoTag, emptyBooleanList, emptyDoubleList, emptyFloatList, emptyIntList, emptyLongList, getAllFields, getDescriptorForType, getField, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, hasField, hasOneof, internalGetMapField, isStringEmpty, makeExtensionsImmutable, mergeFromAndMakeImmutableInternal, mutableCopy, mutableCopy, mutableCopy, mutableCopy, mutableCopy, newBooleanList, newBuilderForType, newDoubleList, newFloatList, newIntList, newLongList, parseDelimitedWithIOException, parseDelimitedWithIOException, parseUnknownField, parseUnknownFieldProto3, parseWithIOException, parseWithIOException, parseWithIOException, parseWithIOException, serializeBooleanMapTo, serializeIntegerMapTo, serializeLongMapTo, serializeStringMapTo, writeReplace, writeString, writeStringNoTag

    Methods inherited from class com.google.protobuf.AbstractMessage

    findInitializationErrors, getInitializationErrorString, hashBoolean, hashEnum, hashEnumList, hashFields, hashLong, toString

    Methods inherited from class com.google.protobuf.AbstractMessageLite

    addAll, addAll, checkByteStringIsUtf8, toByteArray, toByteString, writeDelimitedTo, writeTo

    Methods inherited from class java.lang.Object

    clone, finalize, getClass, notify, notifyAll, wait, wait, wait

    Methods inherited from interface com.google.protobuf.MessageLite

    toByteArray, toByteString, writeDelimitedTo, writeTo

    Methods inherited from interface com.google.protobuf.MessageOrBuilder

    findInitializationErrors, getAllFields, getDescriptorForType, getField, getInitializationErrorString, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, hasField, hasOneof

  • Field Details

  • Method Details

    • newInstance

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

    • getUnknownFields

      public final com.google.protobuf.UnknownFieldSet getUnknownFields()
      Specified by:
      getUnknownFields in interface com.google.protobuf.MessageOrBuilder
      Overrides:
      getUnknownFields 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

    • getPoolingCase

      public EmbeddingModel.PoolingCase getPoolingCase()
      Specified by:
      getPoolingCase in interface EmbeddingModelOrBuilder

    • getModelTypeValue

      public int getModelTypeValue()
       Each embedding has to be implemented, thus this enum is used to select the correct one.
      .arg_services.nlp.v1.EmbeddingType model_type = 1 [json_name = "modelType"];
      Specified by:
      getModelTypeValue in interface EmbeddingModelOrBuilder
      Returns:
      The enum numeric value on the wire for modelType.

    • getModelType

      public EmbeddingType getModelType()
       Each embedding has to be implemented, thus this enum is used to select the correct one.
      .arg_services.nlp.v1.EmbeddingType model_type = 1 [json_name = "modelType"];
      Specified by:
      getModelType in interface EmbeddingModelOrBuilder
      Returns:
      The modelType.

    • getModelName

      public String getModelName()
       You have to specify the name of the model that should be used by the selected impelemtation (i.e., `model_type`).
 We provide links to exemplary models for each implementation in the documentation of `EmbeddingType`.
      string model_name = 2 [json_name = "modelName"];
      Specified by:
      getModelName in interface EmbeddingModelOrBuilder
      Returns:
      The modelName.

    • getModelNameBytes

      public com.google.protobuf.ByteString getModelNameBytes()
       You have to specify the name of the model that should be used by the selected impelemtation (i.e., `model_type`).
 We provide links to exemplary models for each implementation in the documentation of `EmbeddingType`.
      string model_name = 2 [json_name = "modelName"];
      Specified by:
      getModelNameBytes in interface EmbeddingModelOrBuilder
      Returns:
      The bytes for modelName.

    • hasPoolingType

      public boolean hasPoolingType()
       Standard pooling functions like mean, min, max.
      .arg_services.nlp.v1.Pooling pooling_type = 3 [json_name = "poolingType"];
      Specified by:
      hasPoolingType in interface EmbeddingModelOrBuilder
      Returns:
      Whether the poolingType field is set.

    • getPoolingTypeValue

      public int getPoolingTypeValue()
       Standard pooling functions like mean, min, max.
      .arg_services.nlp.v1.Pooling pooling_type = 3 [json_name = "poolingType"];
      Specified by:
      getPoolingTypeValue in interface EmbeddingModelOrBuilder
      Returns:
      The enum numeric value on the wire for poolingType.

    • getPoolingType

      public Pooling getPoolingType()
       Standard pooling functions like mean, min, max.
      .arg_services.nlp.v1.Pooling pooling_type = 3 [json_name = "poolingType"];
      Specified by:
      getPoolingType in interface EmbeddingModelOrBuilder
      Returns:
      The poolingType.

    • hasPmean

      public boolean hasPmean()
       Power mean (or generalized mean).
 This method allows you to alter the computation of the mean representation.
 Special cases include arithmetic mean (p = 1), geometric mean (p = 0), harmonic mean (p = -1), minimum (p = -∞), maximum (p = ∞).
 [Wikipedia](https://en.wikipedia.org/wiki/Generalized_mean).
 [Paper](https://arxiv.org/abs/1803.01400).
      double pmean = 4 [json_name = "pmean"];
      Specified by:
      hasPmean in interface EmbeddingModelOrBuilder
      Returns:
      Whether the pmean field is set.

    • getPmean

      public double getPmean()
       Power mean (or generalized mean).
 This method allows you to alter the computation of the mean representation.
 Special cases include arithmetic mean (p = 1), geometric mean (p = 0), harmonic mean (p = -1), minimum (p = -∞), maximum (p = ∞).
 [Wikipedia](https://en.wikipedia.org/wiki/Generalized_mean).
 [Paper](https://arxiv.org/abs/1803.01400).
      double pmean = 4 [json_name = "pmean"];
      Specified by:
      getPmean in interface EmbeddingModelOrBuilder
      Returns:
      The pmean.

    • 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 EmbeddingModel parseFrom(ByteBuffer data) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

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

    • parseFrom

      public static EmbeddingModel parseFrom(com.google.protobuf.ByteString data) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

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

    • parseFrom

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

    • parseFrom

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

    • parseFrom

      public static EmbeddingModel parseFrom(InputStream input) throws IOException
      Throws:
      IOException

    • parseFrom

      public static EmbeddingModel parseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
      Throws:
      IOException

    • parseDelimitedFrom

      public static EmbeddingModel parseDelimitedFrom(InputStream input) throws IOException
      Throws:
      IOException

    • parseDelimitedFrom

      public static EmbeddingModel parseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
      Throws:
      IOException

    • parseFrom

      public static EmbeddingModel parseFrom(com.google.protobuf.CodedInputStream input) throws IOException
      Throws:
      IOException

    • parseFrom

      public static EmbeddingModel parseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
      Throws:
      IOException

    • newBuilderForType

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

    • newBuilder

      public static EmbeddingModel.Builder newBuilder()

    • newBuilder

      public static EmbeddingModel.Builder newBuilder(EmbeddingModel prototype)

    • toBuilder

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

    • newBuilderForType

      protected EmbeddingModel.Builder newBuilderForType(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)
      Specified by:
      newBuilderForType in class com.google.protobuf.GeneratedMessageV3

    • getDefaultInstance

      public static EmbeddingModel getDefaultInstance()

    • parser

      public static com.google.protobuf.Parser<EmbeddingModel> parser()

    • getParserForType

      public com.google.protobuf.Parser<EmbeddingModel> 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 EmbeddingModel getDefaultInstanceForType()
      Specified by:
      getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder
      Specified by:
      getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder