Merge remote-tracking branch 'upstream/main' into unit_test_9

Ami11111 · Aug 30, 2024 · 011615b · 011615b
2 parents 4953dcd + c8868a7
commit 011615b
Show file tree

Hide file tree

Showing 3 changed files with 136 additions and 36 deletions.
diff --git a/docs/references/http_api_reference.mdx b/docs/references/http_api_reference.mdx
@@ -324,31 +324,38 @@ curl --request POST \
              },
              {
                   "name": "score",
-                  "type": "float"
+                  "type": "float",
+                  "default": 3.0
              },
              {
                   "name": "dense_column",
-                  "type": "vector,8,float"
+                  "type": "vector,8,float",
+                  "default`: [0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0]
              },
              {
-                  "name": "body",
-                  "type": "varchar"
+                  "name": "fulltext_column",
+                  "type": "varchar",
+                  "default": ""
              },
              {
                   "name": "sparse_column",
-                  "type": "sparse,8,float,int"
+                  "type": "sparse,128,float,int",
+                  "default": {"10":1.1, "20":2.2, "30": 3.3}
              },
              {
                   "name": "tensor_column",
-                  "type": "tensor,8,float"
+                  "type": "tensor,4,float",
+                  "default": [[1.0, 0.0, 0.0, 0.0], [1.1, 0.0, 0.0, 0.0]]
              },  
              {
                   "name": "multivector_column",
-                  "type": "multivector,8,float"
+                  "type": "multivector,4,float",
+                  "default": [[0.0, 0.0, 0.0, 0.0], [0.0, 0.0, 0.0, 0.0]]
              },    
              {
                   "name": "tensorarray_column",
-                  "type": "tensorarray,8,float"
+                  "type": "tensorarray,2,float",
+                  "default": [[[1.0, 1.0], [1.0, 1.0]], [[1.0, 1.0]]]
              }          
         ]
     } '
@@ -402,6 +409,8 @@ curl --request POST \
         - `"int64"`
         - `"float"`/`"float32"`
         - `"double"`/`"float64"`
+        - `"float16"`
+        - `"bfloat16"`
     - Sparse vector: e.g., `"sparse,128,float,int"`
       - `sparse`: The column is a sparse vector column.
       - The second item in the string: The dimension of the sparse vector.
@@ -412,6 +421,8 @@ curl --request POST \
         - `"int64"`
         - `"float"`/`"float32"`
         - `"double"`/`"float64"`
+        - `"float16"`
+        - `"bfloat16"`
       - The fourth item in the string: The data type of the sparse vector indices. Can be:
         - `int8`
         - `int16`
@@ -427,6 +438,8 @@ curl --request POST \
         - `"int64"`
         - `"float"`/`"float32"`
         - `"double"`/`"float64"`
+        - `"float16"`
+        - `"bfloat16"`
     - Tensor array: e.g., `"tensorarray,6,float"`
       - `tensorarray`: The column is a tensor-array column.
       - The second item in the string: The dimension of each vector unit in the tensor arrays.
@@ -437,6 +450,8 @@ curl --request POST \
         - `"int64"`
         - `"float"`/`"float32"`
         - `"double"`/`"float64"`
+        - `"float16"`
+        - `"bfloat16"`
     - Multivector: e.g., `"multivector,128,float"`
       - `multivector`: The column is a multi-vector column.
       - The second item in the string: The dimension of each vector unit.
@@ -447,6 +462,10 @@ curl --request POST \
         - `"int64"`
         - `"float"`/`"float32"`
         - `"double"`/`"float64"`
+        - `"float16"`
+        - `"bfloat16"`
+  - `"default"`: `Any`, *Optional*  
+    The default value for unspecified cells in that column.
 
 ### Response
 
@@ -1081,7 +1100,7 @@ The response includes a JSON object like the following:
     "indexes": 
     [
         {
-            "columns": "vector_column",
+            "columns": "vector_column_1",
             "index_name": "idx1",
             "index_type": "HNSW"
         },
@@ -1418,7 +1437,13 @@ curl --request POST \
           },
           {
                "name": "Neil",
-               "score": 2.0
+               "score": 2.0,
+               "fulltext_column": "You're absolutely lucky.",
+               "dense_column": [0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0],
+               "sparse_column": {"10":1.1, "20":2.2, "30": 3.3},
+               "tensor_column": [[1.0, 0.0, 0.0, 0.0], [1.1, 0.0, 0.0, 0.0]],
+               "tensorarray_column": [[[1.0, 1.0], [1.0, 1.0]], [[1.0, 1.0]]],
+               "multivector_column": [[0.0, 0.0, 0.0, 0.0], [0.0, 0.0, 0.0, 0.0]]
           }
      ] '  
 ```

diff --git a/docs/references/pysdk_api_reference.md b/docs/references/pysdk_api_reference.md
@@ -332,7 +332,82 @@ A non-empty string indicating the name of the table, which must adhere to the fo
 Definitions for all table columns as a dictionary. Each key in the dictionary is a column name (`str`), with a corresponding 'value' dictionary defining the column's data type and default value information in key-value pairs:
 
 - **Data type** (`"type"`)  
-  The data type of the column.
+  The data type of the column.  
+  - Numeric:  
+  - `"int8"`
+  - `"int16"`
+  - `"int"`/`"int32"`/`"integer"`
+  - `"int64"`
+  - `"float"`/`"float32"`
+  - `"double"`/`"float64"`
+  - `"float16"`
+  - `"bfloat16"`
+- String: `"varchar"`
+- Dense vector: e.g., `"vector,128,float"`
+  - `vector`: The column is a dense vector column.
+  - The second item in the string: The dimension of the dense vector.
+  - The third item in the string: The element type of the dense vector. Can be:
+    - `"int8"`
+    - `"int16"`
+    - `"int"`/`"int32"`/`"integer"`
+    - `"int64"`
+    - `"float"`/`"float32"`
+    - `"double"`/`"float64"`
+    - `"float16"`
+    - `"bfloat16"`
+- Sparse vector: e.g., `"sparse,128,float,int"`
+  - `sparse`: The column is a sparse vector column.
+  - The second item in the string: The dimension of the sparse vector.
+  - The third item in the string: The element type of the sparse vector. Can be:
+    - `"int8"`
+    - `"int16"`
+    - `"int"`/`"int32"`/`"integer"`
+    - `"int64"`
+    - `"float"`/`"float32"`
+    - `"double"`/`"float64"`
+    - `"float16"`
+    - `"bfloat16"`
+  - The fourth item in the string: The data type of the sparse vector indices. Can be:
+    - `int8`
+    - `int16`
+    - `int`/`int32`/`integer`
+    - `int64`
+- Tensor vector: e.g., `"tensor,4,float"`
+  - `tensor`: The column is a tensor column.
+  - The second item in the string: The dimension of each vector unit in the tensor.
+  - The third item in the string: The element type of the tensors. Can be:
+    - `"int8"`
+    - `"int16"`
+    - `"int"`/`"int32"`/`"integer"`
+    - `"int64"`
+    - `"float"`/`"float32"`
+    - `"double"`/`"float64"`
+    - `"float16"`
+    - `"bfloat16"`
+- Tensor array: e.g., `"tensorarray,6,float"`
+  - `tensorarray`: The column is a tensor-array column.
+  - The second item in the string: The dimension of each vector unit in the tensor arrays.
+  - The third item in the string: The element type of the tensors. Can be:
+    - `"int8"`
+    - `"int16"`
+    - `"int"`/`"int32"`/`"integer"`
+    - `"int64"`
+    - `"float"`/`"float32"`
+    - `"double"`/`"float64"`
+    - `"float16"`
+    - `"bfloat16"`
+- Multivector: e.g., `"multivector,128,float"`
+  - `multivector`: The column is a multi-vector column.
+  - The second item in the string: The dimension of each vector unit.
+  - The third item in the string: The element type of the tensors. Can be:
+    - `"int8"`
+    - `"int16"`
+    - `"int"`/`"int32"`/`"integer"`
+    - `"int64"`
+    - `"float"`/`"float32"`
+    - `"double"`/`"float64"`
+    - `"float16"`
+    - `"bfloat16"`
 - **Default value** (`"default"`)  
   The default value for unspecified cells in that column.