Skip to content

PutInputVector

Source code in docs_src/capo_s3vectors/types/put_input_vector.py 
15
16
17
18
19
20
21
class PutInputVector(TypedDict, closed=True):
    key: "capo_s3vectors.types.vector_key.VectorKey"
    """<p>The name of the vector. The key uniquely identifies the vector in a vector index. </p>"""
    data: "capo_s3vectors.types.vector_data.VectorData"
    """<p>The vector data of the vector. </p> <p>Vector dimensions must match the dimension count that's configured for the vector index.</p> <ul> <li> <p>For the <code>cosine</code> distance metric, zero vectors (vectors containing all zeros) aren't allowed.</p> </li> <li> <p>For both <code>cosine</code> and <code>euclidean</code> distance metrics, vector data must contain only valid floating-point values. Invalid values such as NaN (Not a Number) or Infinity aren't allowed.</p> </li> </ul>"""
    metadata: "capo_s3vectors.types.vector_metadata.VectorMetadata"
    """<p>Metadata about the vector. All metadata entries undergo validation to ensure they meet the format requirements for size and data types.</p>"""

data instance-attribute 

data: VectorData

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.

key instance-attribute 

key: VectorKey

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

metadata instance-attribute 

metadata: VectorMetadata

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