diff --git a/API_Reference/pymilvus/v2.4.x/ORM/utility/do_bulk_insert.md b/API_Reference/pymilvus/v2.4.x/ORM/utility/do_bulk_insert.md index 558cb1b74..6b2aa21ea 100644 --- a/API_Reference/pymilvus/v2.4.x/ORM/utility/do_bulk_insert.md +++ b/API_Reference/pymilvus/v2.4.x/ORM/utility/do_bulk_insert.md @@ -1,5 +1,11 @@ # do_bulk_insert() +
+ +This function is deprecated in v2.4.x and will be removed in a future release. Please use `bulk_import()` instead. + +
+ This operation bulk-inserts data from specified files. ## Request Syntax diff --git a/API_Reference/pymilvus/v2.4.x/ORM/utility/get_bulk_insert_state.md b/API_Reference/pymilvus/v2.4.x/ORM/utility/get_bulk_insert_state.md index da8291b82..f0fa0225d 100644 --- a/API_Reference/pymilvus/v2.4.x/ORM/utility/get_bulk_insert_state.md +++ b/API_Reference/pymilvus/v2.4.x/ORM/utility/get_bulk_insert_state.md @@ -2,6 +2,12 @@ This operation returns the state of a specified bulk-insert task. +
+ +This function is deprecated in v2.4.x and will be removed in a future release. Please use `get_import_progress()` instead. + +
+ ## Request syntax ```python diff --git a/API_Reference/pymilvus/v2.4.x/ORM/utility/list_bulk_insert_tasks.md b/API_Reference/pymilvus/v2.4.x/ORM/utility/list_bulk_insert_tasks.md index 43991f9d1..29551ab8f 100644 --- a/API_Reference/pymilvus/v2.4.x/ORM/utility/list_bulk_insert_tasks.md +++ b/API_Reference/pymilvus/v2.4.x/ORM/utility/list_bulk_insert_tasks.md @@ -2,6 +2,12 @@ This operation lists all bulk-insert tasks. +
+ +This function is deprecated in v2.4.x and will be removed in a future release. Please use `list_import_jobs()` instead. + +
+ ## Request syntax ```python diff --git a/API_Reference_MDX/milvus-restful/v2.4.x/v2/Import (v2)/Get Progress.mdx b/API_Reference_MDX/milvus-restful/v2.4.x/v2/Import (v2)/Get Progress.mdx index 77437ab68..67da94f17 100644 --- a/API_Reference_MDX/milvus-restful/v2.4.x/v2/Import (v2)/Get Progress.mdx +++ b/API_Reference_MDX/milvus-restful/v2.4.x/v2/Import (v2)/Get Progress.mdx @@ -16,5 +16,5 @@ import RestSpecs from '@site/src/components/RestSpecs'; export const specs = {"summary":"Get Import Job Progress","deprecated":false,"description":"This operation gets the progress of the specified bulk-import job.","x-i18n":{"zh-CN":{"summary":"获取导入任务进度","description":"本接口可获取指定导入任务的进度信息。"}},"x-include-target":["milvus"],"tags":["Import Operations (V2)"],"parameters":[{"name":"Authorization","in":"header","description":"The authentication token should be an API key with appropriate privileges or a pair of colon-joined username and password, like `username:password`.","required":true,"example":"Bearer {{TOKEN}}","schema":{"type":"string"},"x-i18n":{"zh-CN":{"description":"认证令牌，应为具备适当权限的 API 密钥或用冒号分隔的用户名和密码，如 `username:password`。"}}}],"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"dbName":{"type":"string","description":"The name of the target database of this operation.","default":"default","x-i18n":{"zh-CN":{"description":"当前操作的目标数据库名称。"}}},"jobId":{"type":"string","description":"The ID of the bulk-import job of your interest. \nThe [Create Import Jobs](/reference/restful/create-import-jobs-v2) operation usually returns a job ID. You can also call [List Import Jobs](/reference/restful/list-import-jobs-v2) to get the IDs of all bulk-import jobs related to the specific cluster.","x-i18n":{"zh-CN":{"description":"需要查询的导入任务 ID。\n[创建导入任务](/reference/restful/create-import-jobs-v2)操作通常会返回一个任务 ID。您也可以调用[列出导入任务](/reference/restful/list-import-jobs-v2)获取特定集群相关的所有导入任务的 ID。"}}}},"required":["jobId"]},"example":{"jobId":"job-xxxxxxxxxxxxxxxx"}}}},"responses":{"200":{"description":"成功","content":{"application/json":{"schema":{"anyOf":[{"x-tab-label":"success","type":"object","properties":{"code":{"description":"Response code.","x-i18n":{"zh-CN":{"description":"响应码。"}},"type":"integer","example":0},"data":{"type":"object","description":"Response payload which contains the progress of the specified bulk-import job in detail.","x-i18n":{"zh-CN":{"description":"响应负载，为包含指定导入任务进度信息在内的详细信息。"}},"properties":{"collectionName":{"type":"string","description":"The name of the target collection of this bulk-import job.","x-i18n":{"zh-CN":{"description":"当前导入任务的目标 Collection 名称。"}}},"completeTime":{"type":"string","description":"The timestamp indicating when the bulk-import job is complete.","x-i18n":{"zh-CN":{"description":"当前导入任务完成时间。"}}},"details":{"type":"array","items":{"type":"object","properties":{"completeTime":{"type":"string","description":"The timestamp at which the file is processed.","x-i18n":{"zh-CN":{"description":"当前数据文件完成处理时间。"}}},"fileName":{"type":"string","description":"The name of a data file.","x-i18n":{"zh-CN":{"description":"数据文件名称。"}}},"fileSize":{"type":"string","description":"The size of the data file.","x-i18n":{"zh-CN":{"description":"数据文件大小。"}}},"progress":{"type":"string","description":"The progress in percentage.","x-i18n":{"zh-CN":{"description":"进度百分比。"}}},"state":{"type":"string","description":"The processing state of the data file.","x-i18n":{"zh-CN":{"description":"数据文件处理状态。"}},"enum":["Pending","Importing","Completed","Failed"]},"reason":{"type":"string","description":"The reason for the failure to bulk import data. This field stays empty if this job succeeds.","x-i18n":{"zh-CN":{"description":"导入失败原因。如果导入成功，该字段为空。"}}},"importedRows":{"type":"string","description":"The number of rows imported from this file.","x-i18n":{"zh-CN":{"description":"从当前文件导入的行数。"}}},"totalRows":{"type":"string","description":"The number of rows in the specified collection upon the import from this file is complete.","x-i18n":{"zh-CN":{"description":"从当前文件导入数据完成后，目标 Collection 中的总行数。"}}}},"description":"Statistics on data import from a file.","x-i18n":{"zh-CN":{"description":"从某个数据文件中导入数据的统计信息。"}}},"description":"Statistics on data import oriented to data files.","x-i18n":{"zh-CN":{"description":"按数据文件维度分别收集的数据导入统计信息。"}}},"fileSize":{"type":"integer","description":"The uploaded file size in bytes.","x-i18n":{"zh-CN":{"description":"已上传文件大小（字节）。"}}},"jobId":{"type":"integer","description":"The ID of this bulk-import job.","x-i18n":{"zh-CN":{"description":"批量导入任务 ID。"}}},"progress":{"type":"integer","description":"The progress in percentage of the current bulk-import job.","x-i18n":{"zh-CN":{"description":"当前导入任务的进度百分比。"}}},"state":{"type":"string","description":"The state of this bulk-import job.","x-i18n":{"zh-CN":{"description":"当前导入任务的状态。"}},"enum":["Pending","Importing","Completed","Failed"]},"reason":{"type":"string","description":"The reason for the failure to bulk import data. The field value stays empty if this job succeeds.","x-i18n":{"zh-CN":{"description":"当前导入任务失败的原因。任务成功时为空字符串。"}}},"importedRows":{"type":"integer","description":"The number of rows inserted into the specified collection upon this import.","x-i18n":{"zh-CN":{"description":"当前任务完成导入完成后，向目标 Collection 中插入的行数。"}}},"totalRows":{"type":"integer","description":"The number of rows in the specified collection.","x-i18n":{"zh-CN":{"description":"当前导入任务完成后，目标 Collection 中的总行数。"}}}}}}},{"x-tab-label":"failure","description":"Returns an error message.","x-i18n":{"zh-CN":{"description":"返回错误消息。"}},"x-i18n-langs":["zh-CN"],"type":"object","properties":{"code":{"type":"integer","description":"Response code.","x-i18n":{"zh-CN":{"description":"响应码。"}}},"message":{"type":"string","description":"Error message.","x-i18n":{"zh-CN":{"description":"错误描述。"}}}}}]},"examples":{"1":{"summary":"success","x-target-response":"OPTION 1","value":{"code":0,"data":{"jobId":"448761313698322011","collectionName":"medium_articles","fileName":"medium_articles_2020_dpr.json","fileSize":3279917,"state":"Completed","progress":100,"completeTime":"2024-04-01T06:17:55Z","reason":"","totalRows":100000,"details":[{"fileName":"medium_articles_2020_dpr.json","fileSize":3279917,"state":"Completed","progress":100,"completeTime":"2024-04-01T06:17:53Z","reason":""}]}}},"2":{"summary":"failure","x-target-response":"OPTION 2","value":{"code":0,"message":"The token is illegal."}}}}}}},"security":[]} -export const endpoint = "/v2/vectordb/jobs/import/get_progress" +export const endpoint = "/v2/vectordb/jobs/import/describe" export const method = "post"