Interface QueryOutputVector.Builder

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

  • Method Details

    • key

      QueryOutputVector.Builder key(String key)

      The key of the vector in the approximate nearest neighbor search.

      Parameters:
      key - The key of the vector in the approximate nearest neighbor search.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • data

      QueryOutputVector.Builder data(VectorData data)

      The vector data associated with the vector, if requested.

      Parameters:
      data - The vector data associated with the vector, if requested.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • data

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

      The vector data associated with the vector, if requested.

      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

      QueryOutputVector.Builder metadata(Document metadata)

      The metadata associated with the vector, if requested.

      Parameters:
      metadata - The metadata associated with the vector, if requested.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • distance

      QueryOutputVector.Builder distance(Float distance)

      The measure of similarity between the vector in the response and the query vector.

      Parameters:
      distance - The measure of similarity between the vector in the response and the query vector.
      Returns:
      Returns a reference to this object so that method calls can be chained together.