Skip to content

types

Bases: BaseModel

One vector + its metadata, in backend-agnostic form.

Source code in vecparity/types.py 
11
12
13
14
15
16
17
18
19
20
21
22
23
class VectorRecord(BaseModel):
    """One vector + its metadata, in backend-agnostic form."""

    model_config = ConfigDict(arbitrary_types_allowed=True)

    id: str
    vector: list[float]
    metadata: dict[str, Any] = {}
    updated_at: float | None = None
    """Unix timestamp of last write, used for incremental sync cursors."""

    def as_array(self) -> np.ndarray:
        return np.asarray(self.vector, dtype=np.float32)

updated_at = None class-attribute instance-attribute

Unix timestamp of last write, used for incremental sync cursors.

Bases: BaseModel

One result from a similarity search, with its rank preserved.

Source code in vecparity/types.py 
26
27
28
29
30
31
class ScoredMatch(BaseModel):
    """One result from a similarity search, with its rank preserved."""

    id: str
    score: float
    metadata: dict[str, Any] = {}

Bases: BaseModel

A single query used for parity verification.

Either a query_vector is supplied directly, or query_id references a VectorRecord already in the source collection to search with.

Source code in vecparity/types.py 
34
35
36
37
38
39
40
41
42
43
44
45
class QueryCase(BaseModel):
    """A single query used for parity verification.

    Either a query_vector is supplied directly, or query_id references a
    VectorRecord already in the source collection to search *with*.
    """

    query_vector: list[float] | None = None
    query_id: str | None = None
    top_k: int = 10
    label: str | None = None
    """Optional human-readable name, shown in parity reports/CI failures."""

label = None class-attribute instance-attribute

Optional human-readable name, shown in parity reports/CI failures.