From a88ac323fe3699180a96f1be64ebfe3103a46cf4 Mon Sep 17 00:00:00 2001 From: Enrico Zimuel Date: Thu, 5 Dec 2024 09:26:55 +0100 Subject: [PATCH 1/5] Update model/database/spans.yaml Co-authored-by: Alexander Wert --- model/database/spans.yaml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/model/database/spans.yaml b/model/database/spans.yaml index 466f568c9f..659614a541 100644 --- a/model/database/spans.yaml +++ b/model/database/spans.yaml @@ -830,7 +830,7 @@ groups: requirement_level: recommended examples: [3, 1536] - ref: db.vector.query.top_k - brief: the top-k most similar vectors returned by a query + brief: The top-k most similar vectors returned by a query note: > The top-k parameter is usually specified when executing a vector search (i.e. query) requirement_level: From df19d76953cba98e9d246e8e2df4b1fca6d33e50 Mon Sep 17 00:00:00 2001 From: Enrico Zimuel Date: Thu, 5 Dec 2024 09:27:03 +0100 Subject: [PATCH 2/5] Update model/database/spans.yaml Co-authored-by: Alexander Wert --- model/database/spans.yaml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/model/database/spans.yaml b/model/database/spans.yaml index 659614a541..7f26408b44 100644 --- a/model/database/spans.yaml +++ b/model/database/spans.yaml @@ -824,7 +824,7 @@ groups: conditionally_required: If available. examples: ['image_vector', 'embedding_field'] - ref: db.vector.dimension_count - brief: the dimension of the vector (e.g. 1536) + brief: The dimension of the vector (e.g. 1536) note: > The dimension of a vector is typically defined when building an index/collection. requirement_level: recommended From 94c2ca1225904ebdefdfa3477f61b52d1a8dc208 Mon Sep 17 00:00:00 2001 From: Enrico Zimuel Date: Thu, 5 Dec 2024 09:27:10 +0100 Subject: [PATCH 3/5] Update model/database/spans.yaml Co-authored-by: Alexander Wert --- model/database/spans.yaml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/model/database/spans.yaml b/model/database/spans.yaml index 7f26408b44..e3f78db223 100644 --- a/model/database/spans.yaml +++ b/model/database/spans.yaml @@ -817,7 +817,7 @@ groups: conditionally_required: If available. examples: ['1', '5c56c793-69f3-4fbf-87e6-c4bf54c28c26'] - ref: db.vector.field_name - brief: the name field of the vector embedding + brief: The name field of the vector embedding note: > Some vector databases use a field name to store the vector. requirement_level: From 210ecb9088df9896e7d90fe586941952cc6b42da Mon Sep 17 00:00:00 2001 From: Enrico Zimuel Date: Thu, 5 Dec 2024 09:27:17 +0100 Subject: [PATCH 4/5] Update model/database/spans.yaml Co-authored-by: Alexander Wert --- model/database/spans.yaml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/model/database/spans.yaml b/model/database/spans.yaml index e3f78db223..ab10e80c56 100644 --- a/model/database/spans.yaml +++ b/model/database/spans.yaml @@ -810,7 +810,7 @@ groups: conditionally_required: If available. examples: ['cosine', 'dot', 'euclidean', 'manhattan'] - ref: db.record.id - brief: the ID of the record (e.g. the ID of the vector) + brief: The ID of the record (e.g. the ID of the vector) note: > Some vector databases identify a vector using an ID. requirement_level: From 765a4a8b7aa4a31e377fa44472e7b0c2c5112337 Mon Sep 17 00:00:00 2001 From: Enrico Zimuel Date: Thu, 5 Dec 2024 09:27:24 +0100 Subject: [PATCH 5/5] Update model/database/spans.yaml Co-authored-by: Alexander Wert --- model/database/spans.yaml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/model/database/spans.yaml b/model/database/spans.yaml index ab10e80c56..3c3147c31a 100644 --- a/model/database/spans.yaml +++ b/model/database/spans.yaml @@ -803,7 +803,7 @@ groups: If the query doesn't target a specific index, this field MUST NOT be set. examples: ['my_index', 'index1, index2'] - ref: db.search.similarity_metric - brief: specify the metric used in similarity search (e.g. cosine) + brief: Specifies the metric used in similarity search (e.g. cosine) note: > Some vector databases allow specifying the similarity search during a search, while others only allow it when creating an index or collection. requirement_level: