Executes when the index is created.
index(
self,
dims_length: Union[int, None],
vector_query_field: str,
text_field: str,
similarity: Union[DistanceStrategy, None]
) -> Dict| Name | Type | Description |
|---|---|---|
dims_length* | Union[int, None] | Numeric length of the embedding vectors, or None if not using vector-based query. |
vector_query_field* | str | The field containing the vector representations in the index. |
text_field* | str | The field containing the text data in the index. |
similarity* | Union[DistanceStrategy, None] | The similarity strategy to use, or None if not using one. |