docs/v18.3.0

qyverlabs · Jan 10, 2025 · c693438 · c693438
1 parent 101b464
commit c693438
Show file tree

Hide file tree

Showing 4 changed files with 8 additions and 8 deletions.
diff --git a/docs/reference/dsl/query/query_clause.md b/docs/reference/dsl/query/query_clause.md
@@ -246,8 +246,8 @@ Classes
     `get_value(self) ‑> list[str]`
     :
 
-`SimilarFilterClause(value_param: Param | Evaluated[Param], weight_param: Param | Evaluated[Param], field_set: SpaceFieldSet, schema_field: SchemaField)`
-:   SimilarFilterClause(value_param: 'Param | Evaluated[Param]', weight_param: 'Param | Evaluated[Param]', field_set: 'SpaceFieldSet', schema_field: 'SchemaField')
+`SimilarFilterClause(value_param: Param | Evaluated[Param], weight_param: Param | Evaluated[Param], field_set: SpaceFieldSet)`
+:   SimilarFilterClause(value_param: 'Param | Evaluated[Param]', weight_param: 'Param | Evaluated[Param]', field_set: 'SpaceFieldSet')
 
     ### Ancestors (in MRO)
 
@@ -262,9 +262,6 @@ Classes
     `field_set: superlinked.framework.dsl.space.space_field_set.SpaceFieldSet`
     :
 
-    `schema_field: superlinked.framework.common.schema.schema_object.SchemaField`
-    :
-
     ### Instance variables
 
     `annotation: str`
@@ -278,7 +275,7 @@ Classes
 
     ### Methods
 
-    `evaluate(self) ‑> tuple[superlinked.framework.dsl.space.space.Space, superlinked.framework.dsl.query.predicate.binary_predicate.EvaluatedBinaryPredicate[superlinked.framework.dsl.query.predicate.binary_predicate.SimilarPredicate]] | None`
+    `evaluate(self) ‑> tuple[superlinked.framework.dsl.space.space.Space, superlinked.framework.common.interface.weighted.Weighted[float | int | str | superlinked.framework.common.data_types.Vector | list[float] | list[str] | superlinked.framework.common.schema.blob_information.BlobInformation]] | None`
     :
 
     `get_allowed_values(self, param: Param | Evaluated[Param]) ‑> set[collections.abc.Sequence[str] | collections.abc.Sequence[float] | PIL.Image.Image | str | int | float | bool | None | tuple[str | None, str | None]]`

diff --git a/docs/reference/dsl/query/query_descriptor.md b/docs/reference/dsl/query/query_descriptor.md
@@ -83,7 +83,7 @@ Classes
     `get_selected_fields(self) ‑> Sequence[superlinked.framework.common.schema.schema_object.SchemaField]`
     :
 
-    `get_similar_filters(self) ‑> dict[superlinked.framework.dsl.space.space.Space, list[superlinked.framework.dsl.query.predicate.binary_predicate.EvaluatedBinaryPredicate[superlinked.framework.dsl.query.predicate.binary_predicate.SimilarPredicate]]]`
+    `get_similar_filters_spaces(self) ‑> list[superlinked.framework.dsl.space.space.Space]`
     :
 
     `get_weighted_clauses(self) ‑> list[superlinked.framework.dsl.query.query_clause.WeightedQueryClause]`

diff --git a/docs/reference/dsl/space/space.md b/docs/reference/dsl/space/space.md
@@ -4,7 +4,7 @@ Module superlinked.framework.dsl.space.space
 Classes
 -------
 
-`Space(fields: SpaceSchemaFieldT | list[SpaceSchemaFieldT], type_: type | TypeAlias)`
+`Space(fields: SpaceSchemaFieldT | Sequence[SpaceSchemaFieldT], type_: type | TypeAlias)`
 :   Abstract base class for a space.
 
     This class defines the interface for a space in the context of the application.

diff --git a/docs/reference/dsl/space/space_field_set.md b/docs/reference/dsl/space/space_field_set.md
@@ -32,6 +32,9 @@ Classes
     `field_names_text: Sequence[str]`
     :
 
+    `fields_id: str`
+    :
+
     `input_type: type[~SIT]`
     :
-Original file line number
+Diff line change
@@ Expand Up / @@ -32,6 +32,9 @@ Classes @@
         `field_names_text: Sequence[str]`
         :
+        `fields_id: str`
+        :
         `input_type: type[~SIT]`
         :
@@ Expand Down @@