Package ai.pipestream.data.v1

Class Embedding.Builder

java.lang.Object
com.google.protobuf.AbstractMessageLite.Builder
com.google.protobuf.AbstractMessage.Builder<Embedding.Builder>
com.google.protobuf.GeneratedMessage.Builder<Embedding.Builder>
ai.pipestream.data.v1.Embedding.Builder
All Implemented Interfaces:
EmbeddingOrBuilder, com.google.protobuf.Message.Builder, com.google.protobuf.MessageLite.Builder, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Cloneable
Enclosing class:
Embedding
public static final class Embedding.Builder extends com.google.protobuf.GeneratedMessage.Builder<Embedding.Builder> implements EmbeddingOrBuilder
 Vector embedding for a document or document segment.

 Typically represents embeddings for whole documents or large non-chunk segments.
Protobuf type ai.pipestream.data.v1.Embedding

  • Method Summary

    Modifier and Type
    Method
    Description
    Embedding.Builder
    addAllVector(Iterable<? extends Float> values)
    Vector representation as floating-point values.
    Embedding.Builder
    addVector(float value)
    Vector representation as floating-point values.
    Embedding
    build()
     
    Embedding
    buildPartial()
     
    Embedding.Builder
    clear()
     
    Embedding.Builder
    clearModelId()
    Model identifier that generated this embedding.
    Embedding.Builder
    clearVector()
    Vector representation as floating-point values.
    Embedding
    getDefaultInstanceForType()
     
    static final com.google.protobuf.Descriptors.Descriptor
    getDescriptor()
     
    com.google.protobuf.Descriptors.Descriptor
    getDescriptorForType()
     
    String
    getModelId()
    Model identifier that generated this embedding.
    com.google.protobuf.ByteString
    getModelIdBytes()
    Model identifier that generated this embedding.
    float
    getVector(int index)
    Vector representation as floating-point values.
    int
    getVectorCount()
    Vector representation as floating-point values.
    List<Float>
    getVectorList()
    Vector representation as floating-point values.
    boolean
    hasModelId()
    Model identifier that generated this embedding.
    protected com.google.protobuf.GeneratedMessage.FieldAccessorTable
    internalGetFieldAccessorTable()
     
    final boolean
    isInitialized()
     
    Embedding.Builder
    mergeFrom(Embedding other)
     
    Embedding.Builder
    mergeFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    Embedding.Builder
    mergeFrom(com.google.protobuf.Message other)
     
    Embedding.Builder
    setModelId(String value)
    Model identifier that generated this embedding.
    Embedding.Builder
    setModelIdBytes(com.google.protobuf.ByteString value)
    Model identifier that generated this embedding.
    Embedding.Builder
    setVector(int index, float value)
    Vector representation as floating-point values.

    Methods inherited from class com.google.protobuf.GeneratedMessage.Builder

    addRepeatedField, clearField, clearOneof, clone, getAllFields, getField, getFieldBuilder, getOneofFieldDescriptor, getParentForChildren, getRepeatedField, getRepeatedFieldBuilder, getRepeatedFieldCount, getUnknownFields, getUnknownFieldSetBuilder, hasField, hasOneof, internalGetMapField, internalGetMapFieldReflection, internalGetMutableMapField, internalGetMutableMapFieldReflection, isClean, markClean, mergeUnknownFields, mergeUnknownLengthDelimitedField, mergeUnknownVarintField, newBuilderForField, onBuilt, onChanged, parseUnknownField, setField, setRepeatedField, setUnknownFields, setUnknownFieldSetBuilder, setUnknownFieldsProto3

    Methods inherited from class com.google.protobuf.AbstractMessage.Builder

    findInitializationErrors, getInitializationErrorString, internalMergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, newUninitializedMessageException, toString

    Methods inherited from class com.google.protobuf.AbstractMessageLite.Builder

    addAll, addAll, mergeDelimitedFrom, mergeDelimitedFrom, mergeFrom, newUninitializedMessageException

    Methods inherited from class java.lang.Object

    equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

    Methods inherited from interface com.google.protobuf.Message.Builder

    mergeDelimitedFrom, mergeDelimitedFrom

    Methods inherited from interface com.google.protobuf.MessageLite.Builder

    mergeFrom

    Methods inherited from interface com.google.protobuf.MessageOrBuilder

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

  • Method Details

    • getDescriptor

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

    • internalGetFieldAccessorTable

      protected com.google.protobuf.GeneratedMessage.FieldAccessorTable internalGetFieldAccessorTable()
      Specified by:
      internalGetFieldAccessorTable in class com.google.protobuf.GeneratedMessage.Builder<Embedding.Builder>

    • clear

      public Embedding.Builder clear()
      Specified by:
      clear in interface com.google.protobuf.Message.Builder
      Specified by:
      clear in interface com.google.protobuf.MessageLite.Builder
      Overrides:
      clear in class com.google.protobuf.GeneratedMessage.Builder<Embedding.Builder>

    • getDescriptorForType

      public com.google.protobuf.Descriptors.Descriptor getDescriptorForType()
      Specified by:
      getDescriptorForType in interface com.google.protobuf.Message.Builder
      Specified by:
      getDescriptorForType in interface com.google.protobuf.MessageOrBuilder
      Overrides:
      getDescriptorForType in class com.google.protobuf.GeneratedMessage.Builder<Embedding.Builder>

    • getDefaultInstanceForType

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

    • build

      public Embedding build()
      Specified by:
      build in interface com.google.protobuf.Message.Builder
      Specified by:
      build in interface com.google.protobuf.MessageLite.Builder

    • buildPartial

      public Embedding buildPartial()
      Specified by:
      buildPartial in interface com.google.protobuf.Message.Builder
      Specified by:
      buildPartial in interface com.google.protobuf.MessageLite.Builder

    • mergeFrom

      public Embedding.Builder mergeFrom(com.google.protobuf.Message other)
      Specified by:
      mergeFrom in interface com.google.protobuf.Message.Builder
      Overrides:
      mergeFrom in class com.google.protobuf.AbstractMessage.Builder<Embedding.Builder>

    • mergeFrom

      public Embedding.Builder mergeFrom(Embedding other)

    • isInitialized

      public final boolean isInitialized()
      Specified by:
      isInitialized in interface com.google.protobuf.MessageLiteOrBuilder
      Overrides:
      isInitialized in class com.google.protobuf.GeneratedMessage.Builder<Embedding.Builder>

    • mergeFrom

      public Embedding.Builder mergeFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
      Specified by:
      mergeFrom in interface com.google.protobuf.Message.Builder
      Specified by:
      mergeFrom in interface com.google.protobuf.MessageLite.Builder
      Overrides:
      mergeFrom in class com.google.protobuf.AbstractMessage.Builder<Embedding.Builder>
      Throws:
      IOException

    • hasModelId

      public boolean hasModelId()
       Model identifier that generated this embedding.
      optional string model_id = 1 [json_name = "modelId"];
      Specified by:
      hasModelId in interface EmbeddingOrBuilder
      Returns:
      Whether the modelId field is set.

    • getModelId

      public String getModelId()
       Model identifier that generated this embedding.
      optional string model_id = 1 [json_name = "modelId"];
      Specified by:
      getModelId in interface EmbeddingOrBuilder
      Returns:
      The modelId.

    • getModelIdBytes

      public com.google.protobuf.ByteString getModelIdBytes()
       Model identifier that generated this embedding.
      optional string model_id = 1 [json_name = "modelId"];
      Specified by:
      getModelIdBytes in interface EmbeddingOrBuilder
      Returns:
      The bytes for modelId.

    • setModelId

      public Embedding.Builder setModelId(String value)
       Model identifier that generated this embedding.
      optional string model_id = 1 [json_name = "modelId"];
      Parameters:
      value - The modelId to set.
      Returns:
      This builder for chaining.

    • clearModelId

      public Embedding.Builder clearModelId()
       Model identifier that generated this embedding.
      optional string model_id = 1 [json_name = "modelId"];
      Returns:
      This builder for chaining.

    • setModelIdBytes

      public Embedding.Builder setModelIdBytes(com.google.protobuf.ByteString value)
       Model identifier that generated this embedding.
      optional string model_id = 1 [json_name = "modelId"];
      Parameters:
      value - The bytes for modelId to set.
      Returns:
      This builder for chaining.

    • getVectorList

      public List<Float> getVectorList()
       Vector representation as floating-point values.
      repeated float vector = 2 [json_name = "vector"];
      Specified by:
      getVectorList in interface EmbeddingOrBuilder
      Returns:
      A list containing the vector.

    • getVectorCount

      public int getVectorCount()
       Vector representation as floating-point values.
      repeated float vector = 2 [json_name = "vector"];
      Specified by:
      getVectorCount in interface EmbeddingOrBuilder
      Returns:
      The count of vector.

    • getVector

      public float getVector(int index)
       Vector representation as floating-point values.
      repeated float vector = 2 [json_name = "vector"];
      Specified by:
      getVector in interface EmbeddingOrBuilder
      Parameters:
      index - The index of the element to return.
      Returns:
      The vector at the given index.

    • setVector

      public Embedding.Builder setVector(int index, float value)
       Vector representation as floating-point values.
      repeated float vector = 2 [json_name = "vector"];
      Parameters:
      index - The index to set the value at.
      value - The vector to set.
      Returns:
      This builder for chaining.

    • addVector

      public Embedding.Builder addVector(float value)
       Vector representation as floating-point values.
      repeated float vector = 2 [json_name = "vector"];
      Parameters:
      value - The vector to add.
      Returns:
      This builder for chaining.

    • addAllVector

      public Embedding.Builder addAllVector(Iterable<? extends Float> values)
       Vector representation as floating-point values.
      repeated float vector = 2 [json_name = "vector"];
      Parameters:
      values - The vector to add.
      Returns:
      This builder for chaining.

    • clearVector

      public Embedding.Builder clearVector()
       Vector representation as floating-point values.
      repeated float vector = 2 [json_name = "vector"];
      Returns:
      This builder for chaining.