本文介紹如何通過Python SDK更新Collection中已存在的Doc。
若更新Doc時指定id不存在，則本次更新Doc操作無效
如只更新部分屬性fields，其他未更新屬性fields默認被置為
NonePython SDK 1.0.11版本后，更新Doc時vector變為非必填項
前提條件
已創建Cluster：創建Cluster。
已獲得API-KEY：API-KEY管理。
已安裝最新版SDK：安裝DashVector SDK。
接口定義
Collection.update(
docs: Union[Doc, List[Doc], Tuple, List[Tuple]],
partition: Optional[str] = None,
async_req: False
) -> DashVectorResponse使用示例
需要使用您的api-key替換示例中的YOUR_API_KEY、您的Cluster Endpoint替換示例中的YOUR_CLUSTER_ENDPOINT，代碼才能正常運行。
本示例需要參考新建Collection-使用示例提前創建好名稱為
quickstart的Collection。
import dashvector
from dashvector import Doc
import numpy as np
client = dashvector.Client(
api_key='YOUR_API_KEY',
endpoint='YOUR_CLUSTER_ENDPOINT'
)
collection = client.get(name='quickstart')更新Doc
# 通過Doc對象update
ret = collection.update(
Doc(
id='1',
vector=[0.1, 0.2, 0.3, 0.4]
)
)
# 判斷update是否成功
assert ret
# 簡化形式：通過Tuple update
ret = collection.update(
('2', [0.1, 0.1, 0.1, 0.1]) # (id, vector)
)更新帶有Fields的Doc
# update單條數據，并設置Fields Value
ret = collection.update(
Doc(
id='3',
vector=np.random.rand(4),
fields={
# 設置創建Collection時預定義的Fields Value
'name': 'zhangsan', 'weight':70.0, 'age':30,
# 設置Schema-Free的Field & Value
'anykey1': 'str-value', 'anykey2': 1,
'anykey3': True, 'anykey4': 3.1415926
}
)
)
# update單條數據，并設置Fields Value
ret = collection.update(
('4', np.random.rand(4), {'foo': 'bar'}) # (id, vector, fields)
)批量更新Doc
# 通過Doc對象，批量update 10條數據
ret = collection.update(
[
Doc(id=str(i+5), vector=np.random.rand(4)) for i in range(10)
]
)
# 簡化形式：通過Tuple，批量update 3條數據
ret = collection.update(
[
('15', [0.2,0.7,0.8,1.3], {'age': 20}),
('16', [0.3,0.6,0.9,1.2], {'age': 30}),
('17', [0.4,0.5,1.0,1.1], {'age': 40})
] # List[(id, vector, fields)]
)
# 判斷批量update是否成功
assert ret異步更新Doc
# 異步批量update 10條數據
ret_funture = collection.update(
[
Doc(id=str(i+18), vector=np.random.rand(4), fields={'name': 'foo' + str(i)}) for i in range(10)
],
async_req=True
)
# 等待并獲取異步update結果
ret = ret_funture.get()更新帶有Sparse Vector的Doc
ret = collection.update(
Doc(
id='28',
vector=[0.1, 0.2, 0.3, 0.4],
sparse_vector={1:0.4, 10000:0.6, 222222:0.8}
)
)入參描述
參數 | 類型 | 默認值 | 說明 |
docs | - | 更新的數據或數據list | |
partition（可選） | Optional[str] | None | Partition名稱 |
async_req（可選） | bool | False | 是否異步 |
docs參數，vector為非必填項。當類型為Tuple時，可以為
(id, vector)或(id, fields)順序，等同于Doc對象。Doc對象的fields參數，可自由設置“任意”的KeyValue數據，Key必須為
str類型，Value必須為str or int or bool or float。當Key在創建Collection時預先定義過，則Value的類型必須為預定義時的類型
當Key未在創建Collection時預先定義過，則Value的類型可為
str or int or bool or float
是否預先定義Fields，可參考Schema Free。
出參描述
返回結果為DashVectorResponse對象，DashVectorResponse對象中可獲取本次操作結果信息，如下表所示。
字段 | 類型 | 描述 | 示例 |
code | int | 返回值，參考返回狀態碼說明 | 0 |
message | str | 返回消息 | success |
request_id | str | 請求唯一id | 19215409-ea66-4db9-8764-26ce2eb5bb99 |
output | List[DocOpResult] | 返回更新Doc的結果 | |
usage | 對Serverless實例（按量付費）集合的Doc更新請求，成功后返回實際消耗的寫請求單元數 |