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

Class NlpConfig

  • All Implemented Interfaces:
    com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, NlpConfigOrBuilder, java.io.Serializable
    public final class NlpConfig
extends com.google.protobuf.GeneratedMessageV3
implements NlpConfigOrBuilder
     Common message for configuring spacy.
    Protobuf type arg_services.nlp.v1.NlpConfig
    See Also:
    Serialized Form

    • Nested Class Summary

      Nested Classes 
      Modifier and Type Class Description
      static class  NlpConfig.Builder
      Common message for configuring spacy.

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

        com.google.protobuf.GeneratedMessageV3.BuilderParent, com.google.protobuf.GeneratedMessageV3.ExtendableBuilder<MessageT extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT>,​BuilderT extends com.google.protobuf.GeneratedMessageV3.ExtendableBuilder<MessageT,​BuilderT>>, com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT>>, com.google.protobuf.GeneratedMessageV3.ExtendableMessageOrBuilder<MessageT extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT>>, 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

    • Method Summary

      All Methods Static Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      boolean equals​(java.lang.Object obj)  
      static NlpConfig getDefaultInstance()  
      NlpConfig getDefaultInstanceForType()  
      static com.google.protobuf.Descriptors.Descriptor getDescriptor()  
      EmbeddingModel getEmbeddingModels​(int index)
      List of embeddings to use for computing word/sentence vectors.
      int getEmbeddingModelsCount()
      List of embeddings to use for computing word/sentence vectors.
      java.util.List<EmbeddingModel> getEmbeddingModelsList()
      List of embeddings to use for computing word/sentence vectors.
      EmbeddingModelOrBuilder getEmbeddingModelsOrBuilder​(int index)
      List of embeddings to use for computing word/sentence vectors.
      java.util.List<? extends EmbeddingModelOrBuilder> getEmbeddingModelsOrBuilderList()
      List of embeddings to use for computing word/sentence vectors.
      java.lang.String getLanguage()
      Any language supported by spacy (e.g., `en`).
      com.google.protobuf.ByteString getLanguageBytes()
      Any language supported by spacy (e.g., `en`).
      com.google.protobuf.Parser<NlpConfig> getParserForType()  
      int getSerializedSize()  
      SimilarityMethod getSimilarityMethod()
      Mathematical function to determine a similarity score given two strings.
      int getSimilarityMethodValue()
      Mathematical function to determine a similarity score given two strings.
      java.lang.String getSpacyModel()
      Name of the trained spacy pipeline (e.g., `en_core_web_lg`).
      com.google.protobuf.ByteString getSpacyModelBytes()
      Name of the trained spacy pipeline (e.g., `en_core_web_lg`).
      int hashCode()  
      protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()  
      boolean isInitialized()  
      static NlpConfig.Builder newBuilder()  
      static NlpConfig.Builder newBuilder​(NlpConfig prototype)  
      NlpConfig.Builder newBuilderForType()  
      protected NlpConfig.Builder newBuilderForType​(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)  
      protected java.lang.Object newInstance​(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused)  
      static NlpConfig parseDelimitedFrom​(java.io.InputStream input)  
      static NlpConfig parseDelimitedFrom​(java.io.InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)  
      static NlpConfig parseFrom​(byte[] data)  
      static NlpConfig parseFrom​(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)  
      static NlpConfig parseFrom​(com.google.protobuf.ByteString data)  
      static NlpConfig parseFrom​(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)  
      static NlpConfig parseFrom​(com.google.protobuf.CodedInputStream input)  
      static NlpConfig parseFrom​(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)  
      static NlpConfig parseFrom​(java.io.InputStream input)  
      static NlpConfig parseFrom​(java.io.InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)  
      static NlpConfig parseFrom​(java.nio.ByteBuffer data)  
      static NlpConfig parseFrom​(java.nio.ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)  
      static com.google.protobuf.Parser<NlpConfig> parser()  
      NlpConfig.Builder toBuilder()  
      void writeTo​(com.google.protobuf.CodedOutputStream output)  

      • Methods inherited from class com.google.protobuf.GeneratedMessageV3

        canUseUnsafe, computeStringSize, computeStringSizeNoTag, emptyBooleanList, emptyDoubleList, emptyFloatList, emptyIntList, emptyList, emptyLongList, getAllFields, getDescriptorForType, getField, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof, internalGetMapField, isStringEmpty, makeExtensionsImmutable, makeMutableCopy, makeMutableCopy, 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, getUnknownFields, hasField, hasOneof

    • Field Detail

      • SPACY_MODEL_FIELD_NUMBER

        public static final int SPACY_MODEL_FIELD_NUMBER
        See Also:
        Constant Field Values

      • EMBEDDING_MODELS_FIELD_NUMBER

        public static final int EMBEDDING_MODELS_FIELD_NUMBER
        See Also:
        Constant Field Values

      • SIMILARITY_METHOD_FIELD_NUMBER

        public static final int SIMILARITY_METHOD_FIELD_NUMBER
        See Also:
        Constant Field Values

    • Method Detail

      • newInstance

        protected java.lang.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

      • getLanguage

        public java.lang.String getLanguage()
         Any language supported by spacy (e.g., `en`).
 [Reference](https://spacy.io/usage/models#languages).
        string language = 1 [json_name = "language"];
        Specified by:
        getLanguage in interface NlpConfigOrBuilder
        Returns:
        The language.

      • getLanguageBytes

        public com.google.protobuf.ByteString getLanguageBytes()
         Any language supported by spacy (e.g., `en`).
 [Reference](https://spacy.io/usage/models#languages).
        string language = 1 [json_name = "language"];
        Specified by:
        getLanguageBytes in interface NlpConfigOrBuilder
        Returns:
        The bytes for language.

      • getSpacyModel

        public java.lang.String getSpacyModel()
         Name of the trained spacy pipeline (e.g., `en_core_web_lg`).
 If empty, a blank spacy model will be used (e.g., if you only need embeddings and provide custom `embedding_models`.
 [Example: English models](https://spacy.io/models/en).
        string spacy_model = 2 [json_name = "spacyModel"];
        Specified by:
        getSpacyModel in interface NlpConfigOrBuilder
        Returns:
        The spacyModel.

      • getSpacyModelBytes

        public com.google.protobuf.ByteString getSpacyModelBytes()
         Name of the trained spacy pipeline (e.g., `en_core_web_lg`).
 If empty, a blank spacy model will be used (e.g., if you only need embeddings and provide custom `embedding_models`.
 [Example: English models](https://spacy.io/models/en).
        string spacy_model = 2 [json_name = "spacyModel"];
        Specified by:
        getSpacyModelBytes in interface NlpConfigOrBuilder
        Returns:
        The bytes for spacyModel.

      • getEmbeddingModelsList

        public java.util.List<EmbeddingModel> getEmbeddingModelsList()
         List of embeddings to use for computing word/sentence vectors.
 If given, these embeddings will **override** the embeddings of the specified `spacy_model`.
 Multiple models are concatenated to each other, increasing the length of the resulting vector.
        repeated .arg_services.nlp.v1.EmbeddingModel embedding_models = 3 [json_name = "embeddingModels"];
        Specified by:
        getEmbeddingModelsList in interface NlpConfigOrBuilder

      • getEmbeddingModelsOrBuilderList

        public java.util.List<? extends EmbeddingModelOrBuilder> getEmbeddingModelsOrBuilderList()
         List of embeddings to use for computing word/sentence vectors.
 If given, these embeddings will **override** the embeddings of the specified `spacy_model`.
 Multiple models are concatenated to each other, increasing the length of the resulting vector.
        repeated .arg_services.nlp.v1.EmbeddingModel embedding_models = 3 [json_name = "embeddingModels"];
        Specified by:
        getEmbeddingModelsOrBuilderList in interface NlpConfigOrBuilder

      • getEmbeddingModelsCount

        public int getEmbeddingModelsCount()
         List of embeddings to use for computing word/sentence vectors.
 If given, these embeddings will **override** the embeddings of the specified `spacy_model`.
 Multiple models are concatenated to each other, increasing the length of the resulting vector.
        repeated .arg_services.nlp.v1.EmbeddingModel embedding_models = 3 [json_name = "embeddingModels"];
        Specified by:
        getEmbeddingModelsCount in interface NlpConfigOrBuilder

      • getEmbeddingModels

        public EmbeddingModel getEmbeddingModels​(int index)
         List of embeddings to use for computing word/sentence vectors.
 If given, these embeddings will **override** the embeddings of the specified `spacy_model`.
 Multiple models are concatenated to each other, increasing the length of the resulting vector.
        repeated .arg_services.nlp.v1.EmbeddingModel embedding_models = 3 [json_name = "embeddingModels"];
        Specified by:
        getEmbeddingModels in interface NlpConfigOrBuilder

      • getEmbeddingModelsOrBuilder

        public EmbeddingModelOrBuilder getEmbeddingModelsOrBuilder​(int index)
         List of embeddings to use for computing word/sentence vectors.
 If given, these embeddings will **override** the embeddings of the specified `spacy_model`.
 Multiple models are concatenated to each other, increasing the length of the resulting vector.
        repeated .arg_services.nlp.v1.EmbeddingModel embedding_models = 3 [json_name = "embeddingModels"];
        Specified by:
        getEmbeddingModelsOrBuilder in interface NlpConfigOrBuilder

      • getSimilarityMethodValue

        public int getSimilarityMethodValue()
         Mathematical function to determine a similarity score given two strings.
        .arg_services.nlp.v1.SimilarityMethod similarity_method = 4 [json_name = "similarityMethod"];
        Specified by:
        getSimilarityMethodValue in interface NlpConfigOrBuilder
        Returns:
        The enum numeric value on the wire for similarityMethod.

      • getSimilarityMethod

        public SimilarityMethod getSimilarityMethod()
         Mathematical function to determine a similarity score given two strings.
        .arg_services.nlp.v1.SimilarityMethod similarity_method = 4 [json_name = "similarityMethod"];
        Specified by:
        getSimilarityMethod in interface NlpConfigOrBuilder
        Returns:
        The similarityMethod.

      • 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 java.io.IOException
        Specified by:
        writeTo in interface com.google.protobuf.MessageLite
        Overrides:
        writeTo in class com.google.protobuf.GeneratedMessageV3
        Throws:
        java.io.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​(java.lang.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 NlpConfig parseFrom​(java.nio.ByteBuffer data)
                           throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

        public static NlpConfig parseFrom​(java.nio.ByteBuffer data,
                                  com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                           throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

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

      • parseFrom

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

      • parseFrom

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

      • parseFrom

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

      • parseFrom

        public static NlpConfig parseFrom​(java.io.InputStream input)
                           throws java.io.IOException
        Throws:
        java.io.IOException

      • parseFrom

        public static NlpConfig parseFrom​(java.io.InputStream input,
                                  com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                           throws java.io.IOException
        Throws:
        java.io.IOException

      • parseDelimitedFrom

        public static NlpConfig parseDelimitedFrom​(java.io.InputStream input)
                                    throws java.io.IOException
        Throws:
        java.io.IOException

      • parseDelimitedFrom

        public static NlpConfig parseDelimitedFrom​(java.io.InputStream input,
                                           com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                    throws java.io.IOException
        Throws:
        java.io.IOException

      • parseFrom

        public static NlpConfig parseFrom​(com.google.protobuf.CodedInputStream input)
                           throws java.io.IOException
        Throws:
        java.io.IOException

      • parseFrom

        public static NlpConfig parseFrom​(com.google.protobuf.CodedInputStream input,
                                  com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                           throws java.io.IOException
        Throws:
        java.io.IOException

      • newBuilderForType

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

      • toBuilder

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

      • newBuilderForType

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

      • getDefaultInstance

        public static NlpConfig getDefaultInstance()

      • parser

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

      • getParserForType

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