Merge pull request #968 from milvus-io/update-python

update docs

API_Reference_MDX/milvus-restful/v2.4.x/v2/Import (v2)/Create.mdx

@@ -15,6 +15,6 @@ import RestSpecs from '@site/src/components/RestSpecs';
 
 <RestSpecs specs={specs} endpoint={endpoint} method={method} target="milvus" lang="en-US" />
 
-export const specs = {"summary":"Create Import Jobs","deprecated":false,"description":"This operation imports the prepared data files to a <include target=\"milvus\">Milvus instance</include><include target=\"zilliz\">Zilliz Cloud cluster</include>. To learn how to prepare your data files, read <include target=\"milvus\">[Prepare Data Import](https://milvus.io/docs/prepare-source-data.md)</include><include target=\"zilliz\">[Prepare Data Import](/docs/prepare-data-import)</include>.","x-i18n":{"zh-CN":{"summary":"创建导入任务","description":"本接口可将预处理好的数据文件导入到 <include target=\"milvus\">Milvus 实例</include><include target=\"zilliz\">Zilliz Cloud 集群</include>。了解如何准备数据文件，请阅读<include target=\"milvus\">《准备数据导入》</include><include target=\"zilliz\">《准备数据导入》</include>。"}},"tags":["Import Operations (V2)"],"parameters":[{"name":"Authorization","in":"header","description":"The authentication token should be an API key with appropriate privileges.","required":true,"example":"Bearer {{TOKEN}}","schema":{"type":"string"},"x-i18n":{"zh-CN":{"description":"认证令牌，应为具备适当权限的 API 密钥。"}}}],"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"dbName":{"type":"string","description":"The name of the database that to which the collection belongs .\nSetting this to a non-existing database results in an error.","x-i18n":{"zh-CN":{"description":"Collection 所属的数据库名称。设置为不存在的数据库将导致错误。"}},"x-include-target":["milvus"]},"clusterId":{"type":"string","description":"The ID of the cluster to which the collection belongs.\nSetting this to a non-existing cluster results in an error. You can get the cluster ID by calling the [`/v2/clusters`](/reference/restful/list-clusters-v2) endpoint, or copy the cluster ID from the [Zilliz Cloud console](/docs/on-zilliz-cloud-console).","example":"inxx-xxxxxxxxxxxxxxxx","x-i18n":{"zh-CN":{"description":"Collection 所属的集群 ID。设置为不存在的集群将导致错误。您可以通过调用 [`/v2/clusters`](/reference/restful/list-clusters-v2) 端点获取集群 ID，或从 [Zilliz Cloud 控制台](/docs/on-zilliz-cloud-console) 复制集群 ID。"}},"x-include-target":["zilliz"]},"collectionName":{"type":"string","description":"The name of the target collection.\nSetting this to a non-existing collection results in an error.","x-i18n":{"zh-CN":{"description":"目标 Collection 的名称。设置为不存在的 Collection 将导致错误。"}}},"partitionName":{"type":"string","description":"The name of the target partition.\nSetting this to a non-existing partition results in an error.","x-i18n":{"zh-CN":{"description":"目标 Partition 的名称。设置为不存在的 Partition 将导致错误。"}}},"files":{"type":"array","items":{"type":"array","items":{"type":"string","description":"A list of file paths, relative to the root of your Milvus bucket on the MinIO instance shipped along with the Milvus instance.","x-i18n":{"zh-CN":{"description":"文件路径列表，列表中的路径均需位于 MinIO 实例上 Milvus 附带的 Milvus 根目录。"}}},"description":"A sub-list that contains a single JSON or Parquet file, or a set of NumPy files.","x-i18n":{"zh-CN":{"description":"包含单个 JSON 文件, Parquet 文件或一组 NumPy 文件的子列表。"}}},"description":"The files that contain the data to import. The files should reside within the Milvus bucket on the MinIO instance deployed along with your Milvus instance.","x-i18n":{"zh-CN":{"description":"包含待导入数据的文件。这些文件均应位于 MinIO 实例上 Milvus 部署的 Milvus 根目录下。"}},"x-include-target":["milvus"]},"options":{"type":"object","properties":{"timeout":{"type":"string","description":"The timeout duration of the created import jobs. The value should be a positive number suffixed by __s__ (seconds), __m__ (minutes), and __h__(hours). For example, _300s_, _1.5h_, and _1h45_ are all valid values.","x-i18n":{"zh-CN":{"description":"创建导入任务的超时时长。该值应为一个以秒、分钟或小时为单位的正数。例如，300s、1.5h、1h45 都是有效值。"}}}},"description":"Bulk-import options.","x-i18n":{"zh-CN":{"description":"批量导入任务选项设置。"}},"x-include-target":["milvus"]},"objectUrl":{"type":"string","description":"The URL of the object to import. This URL should be accessible to the S3-compatible object storage service, such as AWS S3, GCS, Azure blob storage.","x-i18n":{"zh-CN":{"description":"待导入数据的 URL。该 URL 应来自与诸如阿里云 OSS 或腾讯云 COS 等与 MinIO S3 兼容的对象存储服务。"}},"x-include-target":["zilliz"]},"accessKey":{"type":"string","description":"The access key of the object storage service.","x-i18n":{"zh-CN":{"description":"对象存储服务的访问密钥 (AK)。"}},"x-include-target":["zilliz"]},"secretKey":{"type":"string","description":"The secret access key of the object storage service.","x-i18n":{"zh-CN":{"description":"对象存储服务的访问密钥 (SK)。"}},"x-include-target":["zilliz"]},"token":{"type":"string","description":"A temporary token for you to access the object storage service. The token name and the way to obtain it may vary with cloud providers. For details, refer to [the FAQ](/docs/faq-data-import#can-i-use-session-tokens-when-importing-data-from-an-object-storage-service).","x-include-target":["zilliz"]}},"required":["clusterId","collectionName","objectUrl"]},"examples":{"1":{"summary":"example","x-include-target":["milvus"],"value":{"files":[["/d1782fa1-6b65-4ff3-b05a-43a436342445/1.json"],["/2a12dea7-2eff-4b34-97b6-9554063fd791/1/id.npy","/2a12dea7-2eff-4b34-97b6-9554063fd791/1/vector.npy","/2a12dea7-2eff-4b34-97b6-9554063fd791/1/$meta.npy"],["/a6fb2d1c-7b1b-427c-a8a3-178944e3b66d/1.parquet"]],"collectionName":"quick_setup"}},"2":{"summary":"example","x-include-target":["zilliz"],"value":{"clusterId":"inxx-xxxxxxxxxxxxxxx","collectionName":"medium_articles","partitionName":"","objectUrl":"https://s3.us-west-2.amazonaws.com/publicdataset.zillizcloud.com/medium_articles_2020_dpr/medium_articles_2020_dpr.json","accessKey":"","secretKey":""}}}}}},"responses":{"200":{"description":"The ID of the bulk-import job.","x-i18n":{"zh-CN":{"description":"批量导入任务的 ID。"}},"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":"array","description":"Response payload which carries the IDs of the created bulk-import jobs.","x-i18n":{"zh-CN":{"description":"响应负载，包含了当前操作创建的批量导入任务的 ID。"}},"items":{"type":"object","description":"A created bulk-import job.","x-i18n":{"zh-CN":{"description":"一个已创建的批量导入任务。"}},"properties":{"jobId":{"type":"string","description":"The ID of the current bulk-import job.","x-i18n":{"zh-CN":{"description":"当前创建的批量导入任务 ID。"}}}}}}}},{"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":"job-xxxxxxxxxxxxxxxxxxxxx"}}},"2":{"summary":"failure","x-target-response":"OPTION 1","x-include-target":["milvus"],"value":{"code":0,"message":"The token is illegal."}},"3":{"summary":"failure","x-target-response":"OPTION 2","x-include-target":["zilliz"],"value":{"code":21119,"message":"The apikey is illegal."}}}}}}},"security":[]}
+export const specs = {"summary":"Create Import Jobs","deprecated":false,"description":"This operation imports the prepared data files to a <include target=\"milvus\">Milvus instance</include><include target=\"zilliz\">Zilliz Cloud cluster</include>. To learn how to prepare your data files, read <include target=\"milvus\">[Prepare Data Import](https://milvus.io/docs/prepare-source-data.md)</include><include target=\"zilliz\">[Prepare Data Import](/docs/prepare-data-import)</include>.","x-i18n":{"zh-CN":{"summary":"创建导入任务","description":"本接口可将预处理好的数据文件导入到 <include target=\"milvus\">Milvus 实例</include><include target=\"zilliz\">Zilliz Cloud 集群</include>。了解如何准备数据文件，请阅读<include target=\"milvus\">《准备数据导入》</include><include target=\"zilliz\">《准备数据导入》</include>。"}},"tags":["Import Operations (V2)"],"parameters":[{"name":"Authorization","in":"header","description":"The authentication token should be an API key with appropriate privileges.","required":true,"example":"Bearer {{TOKEN}}","schema":{"type":"string"},"x-i18n":{"zh-CN":{"description":"认证令牌，应为具备适当权限的 API 密钥。"}}}],"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"dbName":{"type":"string","description":"The name of the database that to which the collection belongs .\nSetting this to a non-existing database results in an error.","x-i18n":{"zh-CN":{"description":"Collection 所属的数据库名称。设置为不存在的数据库将导致错误。"}}},"clusterId":{"type":"string","description":"The ID of the cluster to which the collection belongs.\nSetting this to a non-existing cluster results in an error. You can get the cluster ID by calling the [`/v2/clusters`](/reference/restful/list-clusters-v2) endpoint, or copy the cluster ID from the [Zilliz Cloud console](/docs/on-zilliz-cloud-console).","example":"inxx-xxxxxxxxxxxxxxxx","x-i18n":{"zh-CN":{"description":"Collection 所属的集群 ID。设置为不存在的集群将导致错误。您可以通过调用 [`/v2/clusters`](/reference/restful/list-clusters-v2) 端点获取集群 ID，或从 [Zilliz Cloud 控制台](/docs/on-zilliz-cloud-console) 复制集群 ID。"}},"x-include-target":["zilliz"]},"collectionName":{"type":"string","description":"The name of the target collection.\nSetting this to a non-existing collection results in an error.","x-i18n":{"zh-CN":{"description":"目标 Collection 的名称。设置为不存在的 Collection 将导致错误。"}}},"partitionName":{"type":"string","description":"The name of the target partition.\nSetting this to a non-existing partition results in an error.","x-i18n":{"zh-CN":{"description":"目标 Partition 的名称。设置为不存在的 Partition 将导致错误。"}}},"files":{"type":"array","items":{"type":"array","items":{"type":"array","description":"A list of file path lists","items":{"type":"string","description":"A list of file paths that point to the data files to import. The paths should be relative to the Milvus root directory on the MinIO instance deployed along with your Milvus instance. <br/>If the format of the import file is JSON, PARQUET, or CSV, each file path list contains only one file. If the format of the import file is NumPy, each file path list contains a set of NumPy files.","x-i18n":{"zh-CN":{"description":"指向待导入数据的文件路径列表。这些路径应位于 MinIO 实例上 Milvus 部署的 Milvus 根目录下。<br/>如果导入文件格式为 JSON、PARQUET 或 CSV，则每个文件路径列表只包含一个文件。如果导入文件格式为 NumPy，则每个文件路径列表包含一组 NumPy 文件。"}}},"x-i18n":{"zh-CN":{"description":"包含一个文件路径列表的列表。"}}},"description":"A sub-list that contains a single JSON, Parquet, CSV file, or a set of NumPy files.","x-i18n":{"zh-CN":{"description":"包含单个 JSON 文件, Parquet 文件，CSV 文件或一组 NumPy 文件的子列表。"}}},"description":"The files that contain the data to import. The files should reside within the Milvus bucket on the MinIO instance deployed along with your Milvus instance.","x-i18n":{"zh-CN":{"description":"包含待导入数据的文件。这些文件均应位于 MinIO 实例上 Milvus 部署的 Milvus 根目录下。"}},"x-include-target":["milvus"]},"options":{"type":"object","properties":{"timeout":{"type":"string","description":"The timeout duration of the created import jobs. The value should be a positive number suffixed by __s__ (seconds), __m__ (minutes), and __h__(hours). For example, _300s_, _1.5h_, and _1h45_ are all valid values.","x-i18n":{"zh-CN":{"description":"创建导入任务的超时时长。该值应为一个以秒、分钟或小时为单位的正数。例如，300s、1.5h、1h45 都是有效值。"}}}},"description":"Bulk-import options.","x-i18n":{"zh-CN":{"description":"批量导入任务选项设置。"}},"x-include-target":["milvus"]},"objectUrl":{"type":"string","description":"The URL of the object to import. This URL should be accessible to the S3-compatible object storage service, such as AWS S3, GCS, Azure blob storage.","x-i18n":{"zh-CN":{"description":"待导入数据的 URL。该 URL 应来自与诸如阿里云 OSS 或腾讯云 COS 等与 MinIO S3 兼容的对象存储服务。"}},"x-include-target":["zilliz"]},"accessKey":{"type":"string","description":"The access key of the object storage service.","x-i18n":{"zh-CN":{"description":"对象存储服务的访问密钥 (AK)。"}},"x-include-target":["zilliz"]},"secretKey":{"type":"string","description":"The secret access key of the object storage service.","x-i18n":{"zh-CN":{"description":"对象存储服务的访问密钥 (SK)。"}},"x-include-target":["zilliz"]},"token":{"type":"string","description":"A temporary token for you to access the object storage service. The token name and the way to obtain it may vary with cloud providers. For details, refer to [the FAQ](/docs/faq-data-import#can-i-use-session-tokens-when-importing-data-from-an-object-storage-service).","x-include-target":["zilliz"]}},"required":["clusterId","collectionName","objectUrl"]},"examples":{"1":{"summary":"example","x-include-target":["milvus"],"value":{"files":[["/d1782fa1-6b65-4ff3-b05a-43a436342445/1.json"],["/2a12dea7-2eff-4b34-97b6-9554063fd791/1/id.npy","/2a12dea7-2eff-4b34-97b6-9554063fd791/1/vector.npy","/2a12dea7-2eff-4b34-97b6-9554063fd791/1/$meta.npy"],["/a6fb2d1c-7b1b-427c-a8a3-178944e3b66d/1.parquet"]],"collectionName":"quick_setup"}},"2":{"summary":"example","x-include-target":["zilliz"],"value":{"clusterId":"inxx-xxxxxxxxxxxxxxx","collectionName":"medium_articles","partitionName":"","objectUrl":"https://s3.us-west-2.amazonaws.com/publicdataset.zillizcloud.com/medium_articles_2020_dpr/medium_articles_2020_dpr.json","accessKey":"","secretKey":""}}}}}},"responses":{"200":{"description":"The ID of the bulk-import job.","x-i18n":{"zh-CN":{"description":"批量导入任务的 ID。"}},"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":"array","description":"Response payload which carries the IDs of the created bulk-import jobs.","x-i18n":{"zh-CN":{"description":"响应负载，包含了当前操作创建的批量导入任务的 ID。"}},"items":{"type":"object","description":"A created bulk-import job.","x-i18n":{"zh-CN":{"description":"一个已创建的批量导入任务。"}},"properties":{"jobId":{"type":"string","description":"The ID of the current bulk-import job.","x-i18n":{"zh-CN":{"description":"当前创建的批量导入任务 ID。"}}}}}}}},{"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":"job-xxxxxxxxxxxxxxxxxxxxx"}}},"2":{"summary":"failure","x-target-response":"OPTION 1","x-include-target":["milvus"],"value":{"code":0,"message":"The token is illegal."}},"3":{"summary":"failure","x-target-response":"OPTION 2","x-include-target":["zilliz"],"value":{"code":21119,"message":"The apikey is illegal."}}}}}}},"security":[]}
 export const endpoint = "/v2/vectordb/jobs/import/create"
 export const method = "post"