Skip to content

Vectors

Vector fields in Argilla are used to define the vector form of a record that will be reviewed by a user.

Usage Examples

To define a vector field, instantiate the VectorField class with a name and dimenstions, then pass it to the vectors parameter of the Settings class.

settings = rg.Settings(
    fields=[
        rg.TextField(name="text"),
    ],
    vectors=[
        rg.VectorField(
            name="my_vector",
            dimension=768,
            title="Document Embedding",
        ),
    ],
)

To add records with vectors, refer to the rg.Vector class documentation.

Class Reference

rg.VectorField

Bases: SettingsPropertyBase

Vector field for use in Argilla Dataset Settings

Source code in src/argilla_sdk/settings/_field.py 
 71
 72
 73
 74
 75
 76
 77
 78
 79
 80
 81
 82
 83
 84
 85
 86
 87
 88
 89
 90
 91
 92
 93
 94
 95
 96
 97
 98
 99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
class VectorField(SettingsPropertyBase):
    """Vector field for use in Argilla `Dataset` `Settings`"""

    _model: VectorFieldModel

    def __init__(
        self,
        name: str,
        dimensions: int,
        title: Optional[str] = None,
    ) -> None:
        """Vector field for use in Argilla `Dataset` `Settings`

        Parameters:
            name (str): The name of the field
            dimensions (int): The number of dimensions in the vector
            title (Optional[str], optional): The title of the field. Defaults to None.
        """
        self._model = VectorFieldModel(
            name=name,
            title=title,
            dimensions=dimensions,
        )

    @classmethod
    def from_model(cls, model: VectorFieldModel) -> "VectorField":
        instance = cls(name=model.name, dimensions=model.dimensions)
        instance._model = model

        return instance

    @classmethod
    def from_dict(cls, data: dict) -> "VectorField":
        model = VectorFieldModel(**data)
        return cls.from_model(model=model)

    @property
    def dimensions(self) -> int:
        return self._model.dimensions

    @property
    def title(self) -> Optional[str]:
        return self._model.title

    @property
    def name(self) -> str:
        return self._model.name

    @property
    def description(self) -> Optional[str]:
        # TODO: Setting resources should be aligned at the API level
        return None

    @property
    def required(self) -> bool:
        # TODO: Setting resources should be aligned at the API level
        return False

    @property
    def type(self) -> str:
        # TODO: Setting resources should be aligned at the API level
        return "vector"

__init__(name, dimensions, title=None)

Vector field for use in Argilla Dataset Settings

Parameters:

Name Type Description Default
name str

The name of the field

 required
dimensions int

The number of dimensions in the vector

 required
title Optional[str]

The title of the field. Defaults to None.

 None
Source code in src/argilla_sdk/settings/_field.py 
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
def __init__(
    self,
    name: str,
    dimensions: int,
    title: Optional[str] = None,
) -> None:
    """Vector field for use in Argilla `Dataset` `Settings`

    Parameters:
        name (str): The name of the field
        dimensions (int): The number of dimensions in the vector
        title (Optional[str], optional): The title of the field. Defaults to None.
    """
    self._model = VectorFieldModel(
        name=name,
        title=title,
        dimensions=dimensions,
    )