Skip to content

Commit

Permalink
Update op_doc.rst
Browse files Browse the repository at this point in the history
  • Loading branch information
zcdb committed Apr 29, 2024
1 parent 621aa4b commit 97148c6
Showing 1 changed file with 9 additions and 8 deletions.
17 changes: 9 additions & 8 deletions docs/source/use_op/op_doc.rst
Original file line number Diff line number Diff line change
Expand Up @@ -6,11 +6,10 @@ http://router_server represents the router service, $db_name is the created libr
_id is the unique identifier of the record generated by the server, which can be specified by the user. This unique identifier needs to be used to modify and delete data.

$id is a unique identifier generated by the server using the specified value when inserting data. The $id value cannot use special characters such as URL paths. If the record with the unique identifier already exists in the library, it will be updated and overwritten.
Single Insertion
--------


document/upsert
--------
----------------
If primary_id is set, the specified primary key will be used. If not set, generated by Vearch.

If the _id specified when inserting already exists, the existing data is updated; otherwise, it is inserted.
Expand Down Expand Up @@ -108,7 +107,7 @@ The format of the return value of the upsert interface is as follows
total identifies the number of successful insertions, and document_ids returns the generated _id and insertion result information.

document/query
--------
----------------
The /document/query interface is used to accurately search for data that exactly matches the query conditions. The search does not include vector data.

Two methods are supported: one is to obtain documents directly through primary keys, and the other is to obtain corresponding documents based on filter conditions.
Expand Down Expand Up @@ -268,7 +267,7 @@ Query interface return format
}

document/search
--------
------------------------
Supports similarity retrieval based on vector value, together with the Filter expression of a custom scalar field, and returns the specified Top K most similar Documents.

Parameter Description:
Expand Down Expand Up @@ -327,7 +326,7 @@ The index_params parameter specifies the parameters for model calculation. Diffe

IVFPQ:
::

"index_params": {
"parallel_on_queries": 1,
"recall_num" : 100,
Expand All @@ -338,6 +337,7 @@ IVFPQ:

GPU:
::

"index_params": {
"recall_num" : 100,
"nprobe": 80,
Expand All @@ -346,6 +346,7 @@ GPU:

HNSW:
::

"index_params": {
"efSearch": 64,
"metric_type": "L2"
Expand Down Expand Up @@ -519,7 +520,7 @@ search interface return format
}

document/delete
--------
------------------------
Deletion supports two methods: specifying document_ids and filtering conditions.

Delete specified document_ids
Expand All @@ -535,7 +536,7 @@ Delete specified document_ids
Delete documents that meet the filter conditions. size specifies the number of items to delete for each data fragment.
::

curl -H "content-type: application/json" -XPOST -d'
{
"db_name": "ts_db",
Expand Down

0 comments on commit 97148c6

Please sign in to comment.