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

Interface EmbeddingModelOrBuilder

  • All Superinterfaces:
    com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder
    All Known Implementing Classes:
    EmbeddingModel, EmbeddingModel.Builder
    public interface EmbeddingModelOrBuilder
extends com.google.protobuf.MessageOrBuilder

    • Method Summary

      All Methods Instance Methods Abstract Methods 
      Modifier and Type Method Description
      java.lang.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.
      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.
      boolean hasPmean()
      Power mean (or generalized mean).
      boolean hasPoolingType()
      Standard pooling functions like mean, min, max.

      • Methods inherited from interface com.google.protobuf.MessageLiteOrBuilder

        isInitialized

      • Methods inherited from interface com.google.protobuf.MessageOrBuilder

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

    • Method Detail

      • getModelTypeValue

        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"];
        Returns:
        The enum numeric value on the wire for modelType.

      • getModelType

        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"];
        Returns:
        The modelType.

      • getModelName

        java.lang.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"];
        Returns:
        The modelName.

      • getModelNameBytes

        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"];
        Returns:
        The bytes for modelName.

      • hasPoolingType

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

      • getPoolingTypeValue

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

      • getPoolingType

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

      • hasPmean

        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"];
        Returns:
        Whether the pmean field is set.

      • getPmean

        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"];
        Returns:
        The pmean.