Interface PutInputVector.Builder

All Superinterfaces:
Buildable, CopyableBuilder<PutInputVector.Builder,PutInputVector>, SdkBuilder<PutInputVector.Builder,PutInputVector>, SdkPojo
Enclosing class:
PutInputVector
@Mutable @NotThreadSafe public static interface PutInputVector.Builder extends SdkPojo, CopyableBuilder<PutInputVector.Builder,PutInputVector>

  • Method Details

    • key

      PutInputVector.Builder key(String key)

      The name of the vector. The key uniquely identifies the vector in a vector index.

      Parameters:
      key - The name of the vector. The key uniquely identifies the vector in a vector index.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • data

      PutInputVector.Builder data(VectorData data)

      The vector data of the vector.

      Vector dimensions must match the dimension count that's configured for the vector index.

      • For the cosine distance metric, zero vectors (vectors containing all zeros) aren't allowed.

      • For both cosine and euclidean distance metrics, vector data must contain only valid floating-point values. Invalid values such as NaN (Not a Number) or Infinity aren't allowed.

      Parameters:
      data - The vector data of the vector.

      Vector dimensions must match the dimension count that's configured for the vector index.

      • For the cosine distance metric, zero vectors (vectors containing all zeros) aren't allowed.

      • For both cosine and euclidean distance metrics, vector data must contain only valid floating-point values. Invalid values such as NaN (Not a Number) or Infinity aren't allowed.

      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • data

      default PutInputVector.Builder data(Consumer<VectorData.Builder> data)

      The vector data of the vector.

      Vector dimensions must match the dimension count that's configured for the vector index.

      • For the cosine distance metric, zero vectors (vectors containing all zeros) aren't allowed.

      • For both cosine and euclidean distance metrics, vector data must contain only valid floating-point values. Invalid values such as NaN (Not a Number) or Infinity aren't allowed.

      This is a convenience method that creates an instance of the VectorData.Builder avoiding the need to create one manually via VectorData.builder().

      When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to data(VectorData).

      Parameters:
      data - a consumer that will call methods on VectorData.Builder
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • metadata

      PutInputVector.Builder metadata(Document metadata)

      Metadata about the vector. All metadata entries undergo validation to ensure they meet the format requirements for size and data types.

      Parameters:
      metadata - Metadata about the vector. All metadata entries undergo validation to ensure they meet the format requirements for size and data types.
      Returns:
      Returns a reference to this object so that method calls can be chained together.