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

Class NlpConfig

java.lang.Object
com.google.protobuf.AbstractMessageLite
com.google.protobuf.AbstractMessage
com.google.protobuf.GeneratedMessageV3
de.uni_trier.recap.arg_services.nlp.v1.NlpConfig
All Implemented Interfaces:
com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, NlpConfigOrBuilder, 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:

  • Nested Class Summary

    Nested Classes
    Modifier and Type
    Class
    Description
    static final 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<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
    EMBEDDING_MODELS_FIELD_NUMBER
     
    static final int
    LANGUAGE_FIELD_NUMBER
     
    static final int
    SIMILARITY_METHOD_FIELD_NUMBER
     
    static final int
    SPACY_MODEL_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 NlpConfig
    getDefaultInstance()
     
    NlpConfig
    getDefaultInstanceForType()
     
    static final 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.
    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.
    List<? extends EmbeddingModelOrBuilder>
    getEmbeddingModelsOrBuilderList()
    List of embeddings to use for computing word/sentence vectors.
    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.
    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`).
    final com.google.protobuf.UnknownFieldSet
    getUnknownFields()
     
    int
    hashCode()
     
    protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable
    internalGetFieldAccessorTable()
     
    final 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 Object
    newInstance(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused)
     
    static NlpConfig
    parseDelimitedFrom(InputStream input)
     
    static NlpConfig
    parseDelimitedFrom(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(InputStream input)
     
    static NlpConfig
    parseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static NlpConfig
    parseFrom(ByteBuffer data)
     
    static NlpConfig
    parseFrom(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, 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

    • LANGUAGE_FIELD_NUMBER

      public static final int LANGUAGE_FIELD_NUMBER
      See Also:

    • SPACY_MODEL_FIELD_NUMBER

      public static final int SPACY_MODEL_FIELD_NUMBER
      See Also:

    • EMBEDDING_MODELS_FIELD_NUMBER

      public static final int EMBEDDING_MODELS_FIELD_NUMBER
      See Also:

    • SIMILARITY_METHOD_FIELD_NUMBER

      public static final int SIMILARITY_METHOD_FIELD_NUMBER
      See Also:

  • 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

    • getLanguage

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

    • parseFrom

      public static NlpConfig parseFrom(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(InputStream input) throws IOException
      Throws:
      IOException

    • parseFrom

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

    • parseDelimitedFrom

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

    • parseDelimitedFrom

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

    • parseFrom

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

    • parseFrom

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

    • newBuilderForType

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

    • newBuilder

      public static NlpConfig.Builder newBuilder()

    • newBuilder

      public static NlpConfig.Builder newBuilder(NlpConfig prototype)

    • 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