From 3d3e32d640566af82672028a5dba7983c24eff9a Mon Sep 17 00:00:00 2001 From: AnthonyTsu1984 <115786031+AnthonyTsu1984@users.noreply.github.com> Date: Tue, 22 Oct 2024 15:34:34 +0800 Subject: [PATCH] update docs Signed-off-by: AnthonyTsu1984 <115786031+AnthonyTsu1984@users.noreply.github.com> --- API_Reference_MDX/milvus-restful/v2.4.x/v2/Alias (v2)/Alter.mdx | 2 +- .../milvus-restful/v2.4.x/v2/Alias (v2)/Create.mdx | 2 +- .../milvus-restful/v2.4.x/v2/Alias (v2)/Describe.mdx | 2 +- API_Reference_MDX/milvus-restful/v2.4.x/v2/Alias (v2)/Drop.mdx | 2 +- API_Reference_MDX/milvus-restful/v2.4.x/v2/Alias (v2)/List.mdx | 2 +- .../milvus-restful/v2.4.x/v2/Collection (v2)/Create.mdx | 2 +- .../milvus-restful/v2.4.x/v2/Collection (v2)/Get Load State.mdx | 2 +- .../milvus-restful/v2.4.x/v2/Collection (v2)/Has.mdx | 2 +- .../milvus-restful/v2.4.x/v2/Partition (v2)/Create.mdx | 2 +- .../milvus-restful/v2.4.x/v2/Partition (v2)/Get Statistics.mdx | 2 +- .../milvus-restful/v2.4.x/v2/Partition (v2)/Has.mdx | 2 +- .../milvus-restful/v2.4.x/v2/Partition (v2)/Load.mdx | 2 +- .../milvus-restful/v2.4.x/v2/Vector (v2)/Delete.mdx | 2 +- .../milvus-restful/v2.4.x/v2/Vector (v2)/Hybrid Search.mdx | 2 +- .../milvus-restful/v2.4.x/v2/Vector (v2)/Insert.mdx | 2 +- .../milvus-restful/v2.4.x/v2/Vector (v2)/Upsert.mdx | 2 +- 16 files changed, 16 insertions(+), 16 deletions(-) diff --git a/API_Reference_MDX/milvus-restful/v2.4.x/v2/Alias (v2)/Alter.mdx b/API_Reference_MDX/milvus-restful/v2.4.x/v2/Alias (v2)/Alter.mdx index 8c2691eec..14b460a2e 100644 --- a/API_Reference_MDX/milvus-restful/v2.4.x/v2/Alias (v2)/Alter.mdx +++ b/API_Reference_MDX/milvus-restful/v2.4.x/v2/Alias (v2)/Alter.mdx @@ -15,6 +15,6 @@ import RestSpecs from '@site/src/components/RestSpecs'; -export const specs = {"summary":"Alter Alias","deprecated":false,"description":"This operation reassigns the alias of one collection to another.","x-i18n":{"zh-CN":{"summary":"修改别名","description":"本接口将已分配给某 Collection 的别名重新分配给另一个 Collection。"}},"tags":["Alias 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 database to which the collection belongs.","x-i18n":{"zh-CN":{"description":"数据库名称。"}},"x-include-target":["milvus"]},"collectionName":{"type":"string","description":"The name of the target collection to reassign an alias to.","x-i18n":{"zh-CN":{"description":"重新分配后当前别名所指向的 Collection 名称。"}}},"aliasName":{"type":"string","description":"The alias of the collection. ","x-i18n":{"zh-CN":{"description":"待重新分配的别名。"}}}},"required":["aliasName","collectionName"]},"example":{"aliasName":"bob","collectionName":"custom_setup_indexed"}}}},"responses":{"200":{"description":"Returns an empty object or an error message.","x-i18n":{"zh-CN":{"description":"返回一个空对象或一条错误消息。"}},"content":{"application/json":{"schema":{"anyOf":[{"x-tab-label":"success","description":"A success response","x-i18n":{"zh-CN":{"description":"成功响应。"}},"x-i18n-langs":["zh-CN"],"type":"object","properties":{"code":{"description":"Response code.","x-i18n":{"zh-CN":{"description":"响应码。"}},"type":"integer","example":0},"data":{"type":"object","properties":{},"description":"Response payload which is an empty object.","x-i18n":{"zh-CN":{"description":"响应载荷。为空对象。"}}}}},{"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":{}}},"2":{"summary":"failure","x-target-response":"OPTION 2","value":{"code":0,"message":"The token is illegal."}}}}}}},"security":[]} +export const specs = {"summary":"Alter Alias","deprecated":false,"description":"This operation reassigns the alias of one collection to another.","x-i18n":{"zh-CN":{"summary":"修改 Alias","description":"本接口将已分配给某 Collection 的别名重新分配给另一个 Collection。"}},"tags":["Alias 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 database to which the collection belongs.","x-i18n":{"zh-CN":{"description":"数据库名称。"}},"x-include-target":["milvus"]},"collectionName":{"type":"string","description":"The name of the target collection to reassign an alias to.","x-i18n":{"zh-CN":{"description":"重新分配后当前别名所指向的 Collection 名称。"}}},"aliasName":{"type":"string","description":"The alias of the collection. ","x-i18n":{"zh-CN":{"description":"待重新分配的别名。"}}}},"required":["aliasName","collectionName"]},"example":{"aliasName":"bob","collectionName":"custom_setup_indexed"}}}},"responses":{"200":{"description":"Returns an empty object or an error message.","x-i18n":{"zh-CN":{"description":"返回一个空对象或一条错误消息。"}},"content":{"application/json":{"schema":{"anyOf":[{"x-tab-label":"success","description":"A success response","x-i18n":{"zh-CN":{"description":"成功响应。"}},"x-i18n-langs":["zh-CN"],"type":"object","properties":{"code":{"description":"Response code.","x-i18n":{"zh-CN":{"description":"响应码。"}},"type":"integer","example":0},"data":{"type":"object","properties":{},"description":"Response payload which is an empty object.","x-i18n":{"zh-CN":{"description":"响应载荷。为空对象。"}}}}},{"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":{}}},"2":{"summary":"failure","x-target-response":"OPTION 2","value":{"code":0,"message":"The token is illegal."}}}}}}},"security":[]} export const endpoint = "/v2/vectordb/aliases/alter" export const method = "post" diff --git a/API_Reference_MDX/milvus-restful/v2.4.x/v2/Alias (v2)/Create.mdx b/API_Reference_MDX/milvus-restful/v2.4.x/v2/Alias (v2)/Create.mdx index d52f289b4..c23b389a0 100644 --- a/API_Reference_MDX/milvus-restful/v2.4.x/v2/Alias (v2)/Create.mdx +++ b/API_Reference_MDX/milvus-restful/v2.4.x/v2/Alias (v2)/Create.mdx @@ -15,6 +15,6 @@ import RestSpecs from '@site/src/components/RestSpecs'; -export const specs = {"summary":"Create Alias","deprecated":false,"description":"This operation creates an alias for an existing collection. A collection can have multiple aliases, while an alias can be associated with only one collection.","x-i18n":{"zh-CN":{"summary":"创建 Collection 别名","description":"本接口可以为指定 Collection 创建别名。一个 Collection 可以有多个别名,而一个别名只能对应一个 Collection。"}},"tags":["Alias 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 database to which the collection belongs.","x-i18n":{"zh-CN":{"description":"当前 Collection 所属的数据库名称。"}},"x-include-target":["milvus"]},"collectionName":{"type":"string","description":"The name of the target collection to assign the created alias to.","x-i18n":{"zh-CN":{"description":"待创建别名的 Collection 名称。"}}},"aliasName":{"type":"string","description":"The alias of the collection. ","x-i18n":{"zh-CN":{"description":"待创建的 Collection 别名。"}}}},"required":["aliasName","collectionName"]},"example":{"aliasName":"bob","collectionName":"quick_setup"}}}},"responses":{"200":{"description":"None","content":{"application/json":{"schema":{"anyOf":[{"x-tab-label":"success","description":"A success response","x-i18n":{"zh-CN":{"description":"成功响应。"}},"x-i18n-langs":["zh-CN"],"type":"object","properties":{"code":{"description":"Response code.","x-i18n":{"zh-CN":{"description":"响应码。"}},"type":"integer","example":0},"data":{"type":"object","properties":{},"description":"Response payload which is an empty object.","x-i18n":{"zh-CN":{"description":"响应载荷。为空对象。"}}}}},{"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":{}}},"2":{"summary":"failure","x-target-response":"OPTION 2","value":{"code":1802,"message":"reason for failure"}}}}}}},"security":[]} +export const specs = {"summary":"Create Alias","deprecated":false,"description":"This operation creates an alias for an existing collection. A collection can have multiple aliases, while an alias can be associated with only one collection.","x-i18n":{"zh-CN":{"summary":"创建 Alias","description":"本接口可以为指定 Collection 创建别名。一个 Collection 可以有多个别名,而一个别名只能对应一个 Collection。"}},"tags":["Alias 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 database to which the collection belongs.","x-i18n":{"zh-CN":{"description":"当前 Collection 所属的数据库名称。"}},"x-include-target":["milvus"]},"collectionName":{"type":"string","description":"The name of the target collection to assign the created alias to.","x-i18n":{"zh-CN":{"description":"待创建别名的 Collection 名称。"}}},"aliasName":{"type":"string","description":"The alias of the collection. ","x-i18n":{"zh-CN":{"description":"待创建的 Collection 别名。"}}}},"required":["aliasName","collectionName"]},"example":{"aliasName":"bob","collectionName":"quick_setup"}}}},"responses":{"200":{"description":"None","content":{"application/json":{"schema":{"anyOf":[{"x-tab-label":"success","description":"A success response","x-i18n":{"zh-CN":{"description":"成功响应。"}},"x-i18n-langs":["zh-CN"],"type":"object","properties":{"code":{"description":"Response code.","x-i18n":{"zh-CN":{"description":"响应码。"}},"type":"integer","example":0},"data":{"type":"object","properties":{},"description":"Response payload which is an empty object.","x-i18n":{"zh-CN":{"description":"响应载荷。为空对象。"}}}}},{"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":{}}},"2":{"summary":"failure","x-target-response":"OPTION 2","value":{"code":1802,"message":"reason for failure"}}}}}}},"security":[]} export const endpoint = "/v2/vectordb/aliases/create" export const method = "post" diff --git a/API_Reference_MDX/milvus-restful/v2.4.x/v2/Alias (v2)/Describe.mdx b/API_Reference_MDX/milvus-restful/v2.4.x/v2/Alias (v2)/Describe.mdx index dd2b0322b..a189baf5a 100644 --- a/API_Reference_MDX/milvus-restful/v2.4.x/v2/Alias (v2)/Describe.mdx +++ b/API_Reference_MDX/milvus-restful/v2.4.x/v2/Alias (v2)/Describe.mdx @@ -15,6 +15,6 @@ import RestSpecs from '@site/src/components/RestSpecs'; -export const specs = {"summary":"Describe Alias","deprecated":false,"description":"This operation describes the details of a specific alias.","x-i18n":{"zh-CN":{"summary":"查看 Collection 别名详情","description":"本接口可列出指定 Collection 别名的详细信息。"}},"tags":["Alias 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 database to which the alias belongs.","x-i18n":{"zh-CN":{"description":"当前别名所属的数据库名称。"}},"x-include-target":["milvus"]},"aliasName":{"type":"string","description":"The name of the alias whose details are to be listed.","x-i18n":{"zh-CN":{"description":"目标别名。"}}}},"required":["aliasName"]},"example":{"aliasName":"alice"}}}},"responses":{"200":{"description":"An alias object that contains the detailed description of an alias.","x-i18n":{"zh-CN":{"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 carries the detailed description of an alias.","x-i18n":{"zh-CN":{"description":"响应负载,包含了指定 Collection 别名的详细信息。"}},"properties":{"dbName":{"type":"string","description":"The name of the database to which the collection belongs.","x-i18n":{"zh-CN":{"description":"当前别名对应的 Collection 所属的数据库名称。"}},"x-include-target":["milvus"]},"collectionName":{"type":"string","description":"the name of the collection to which an alias belongs.","x-i18n":{"zh-CN":{"description":"当前别名所属的 Collection 名称。"}}},"aliasName":{"type":"string","description":"The name of the alias.","x-i18n":{"zh-CN":{"description":"当前别名。"}}}}}}},{"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":{"aliasName":"alice","collectionName":"quick_setup","dbName":"default"}}},"2":{"summary":"failure","x-target-response":"OPTION 2","value":{"code":0,"message":"The token is illegal."}}}}}}},"security":[]} +export const specs = {"summary":"Describe Alias","deprecated":false,"description":"This operation describes the details of a specific alias.","x-i18n":{"zh-CN":{"summary":"查看 Alias 详情","description":"本接口可列出指定 Collection 别名的详细信息。"}},"tags":["Alias 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 database to which the alias belongs.","x-i18n":{"zh-CN":{"description":"当前别名所属的数据库名称。"}},"x-include-target":["milvus"]},"aliasName":{"type":"string","description":"The name of the alias whose details are to be listed.","x-i18n":{"zh-CN":{"description":"目标别名。"}}}},"required":["aliasName"]},"example":{"aliasName":"alice"}}}},"responses":{"200":{"description":"An alias object that contains the detailed description of an alias.","x-i18n":{"zh-CN":{"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 carries the detailed description of an alias.","x-i18n":{"zh-CN":{"description":"响应负载,包含了指定 Collection 别名的详细信息。"}},"properties":{"dbName":{"type":"string","description":"The name of the database to which the collection belongs.","x-i18n":{"zh-CN":{"description":"当前别名对应的 Collection 所属的数据库名称。"}},"x-include-target":["milvus"]},"collectionName":{"type":"string","description":"the name of the collection to which an alias belongs.","x-i18n":{"zh-CN":{"description":"当前别名所属的 Collection 名称。"}}},"aliasName":{"type":"string","description":"The name of the alias.","x-i18n":{"zh-CN":{"description":"当前别名。"}}}}}}},{"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":{"aliasName":"alice","collectionName":"quick_setup","dbName":"default"}}},"2":{"summary":"failure","x-target-response":"OPTION 2","value":{"code":0,"message":"The token is illegal."}}}}}}},"security":[]} export const endpoint = "/v2/vectordb/aliases/describe" export const method = "post" diff --git a/API_Reference_MDX/milvus-restful/v2.4.x/v2/Alias (v2)/Drop.mdx b/API_Reference_MDX/milvus-restful/v2.4.x/v2/Alias (v2)/Drop.mdx index 831d82065..c1b519fc0 100644 --- a/API_Reference_MDX/milvus-restful/v2.4.x/v2/Alias (v2)/Drop.mdx +++ b/API_Reference_MDX/milvus-restful/v2.4.x/v2/Alias (v2)/Drop.mdx @@ -15,6 +15,6 @@ import RestSpecs from '@site/src/components/RestSpecs'; -export const specs = {"summary":"Drop Alias","deprecated":false,"description":"This operation drops a specified alias. ","x-i18n":{"zh-CN":{"summary":"删除 Alias","description":"本接口可删除指定的 Collection 别名。"}},"tags":["Alias 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 database to which the collection belongs.","x-i18n":{"zh-CN":{"description":"数据库名称。"}},"x-include-target":["milvus"]},"aliasName":{"type":"string","description":"The alias to drop.","x-i18n":{"zh-CN":{"description":"待删除的 Collection 别名。"}}}},"required":["aliasName"]},"example":{"aliasName":"bob"}}}},"responses":{"200":{"description":"Return an empty object or an error message.","content":{"application/json":{"schema":{"anyOf":[{"x-tab-label":"success","description":"A success response","x-i18n":{"zh-CN":{"description":"成功响应。"}},"x-i18n-langs":["zh-CN"],"type":"object","properties":{"code":{"description":"Response code.","x-i18n":{"zh-CN":{"description":"响应码。"}},"type":"integer","example":0},"data":{"type":"object","properties":{},"description":"Response payload which is an empty object.","x-i18n":{"zh-CN":{"description":"响应载荷。为空对象。"}}}}},{"x-tab-label":"failure","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":{}}},"2":{"summary":"failure","x-target-response":"OPTION 2","value":{"code":0,"message":"The token is illegal."}}}}}}},"security":[]} +export const specs = {"summary":"Drop Alias","deprecated":false,"description":"This operation drops a specified alias. ","x-i18n":{"zh-CN":{"summary":"删除 Alias","description":"本接口可删除指定的 Collection 别名。"}},"tags":["Alias 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 database to which the collection belongs.","x-i18n":{"zh-CN":{"description":"数据库名称。"}},"x-include-target":["milvus"]},"collectionName":{"type":"string","description":"The name of the collection to which the alias is assigned to.","x-i18n":{"zh-CN":{"description":"分配了指定别名的 Collection 名称。"}}},"aliasName":{"type":"string","description":"The alias to drop.\nWhen dropping an alias, you do not need to provide the collection name because one alias can only be assigned to exactly one collection. Therefore, the server knows which collection the specified alias belongs to.","x-i18n":{"zh-CN":{"description":"待删除的 Collection 别名。\n 删除别名时无需提供 Collection 名称,因为一个别名只能分配给一个 Collection。因此,服务器可以确定指定的别名属于哪个 Collection。"}}}},"required":["aliasName"]},"example":{"aliasName":"bob"}}}},"responses":{"200":{"description":"Return an empty object or an error message.","content":{"application/json":{"schema":{"anyOf":[{"x-tab-label":"success","description":"A success response","x-i18n":{"zh-CN":{"description":"成功响应。"}},"x-i18n-langs":["zh-CN"],"type":"object","properties":{"code":{"description":"Response code.","x-i18n":{"zh-CN":{"description":"响应码。"}},"type":"integer","example":0},"data":{"type":"object","properties":{},"description":"Response payload which is an empty object.","x-i18n":{"zh-CN":{"description":"响应载荷。为空对象。"}}}}},{"x-tab-label":"failure","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":{}}},"2":{"summary":"failure","x-target-response":"OPTION 2","value":{"code":0,"message":"The token is illegal."}}}}}}},"security":[]} export const endpoint = "/v2/vectordb/aliases/drop" export const method = "post" diff --git a/API_Reference_MDX/milvus-restful/v2.4.x/v2/Alias (v2)/List.mdx b/API_Reference_MDX/milvus-restful/v2.4.x/v2/Alias (v2)/List.mdx index 06d2227af..8d14d0561 100644 --- a/API_Reference_MDX/milvus-restful/v2.4.x/v2/Alias (v2)/List.mdx +++ b/API_Reference_MDX/milvus-restful/v2.4.x/v2/Alias (v2)/List.mdx @@ -15,6 +15,6 @@ import RestSpecs from '@site/src/components/RestSpecs'; -export const specs = {"summary":"List Aliases","deprecated":false,"description":"This operation lists all existing collection aliases in the specified databaseZilliz Cloud cluster.","x-i18n":{"zh-CN":{"summary":"查看 Collection 别名","description":"本接口可列出指定数据库 Zilliz Cloud 集群中的所有 Collection 别名。"}},"tags":["Alias 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 an existing database.","default":"default","x-i18n":{"zh-CN":{"description":"已存在的数据库名称。"}},"x-include-target":["milvus"]},"collectionName":{"type":"string","description":"The name of an existing collection. If specified, only returns aliases of the specified collection. If not specified, returns aliases of all collections in the database.","x-i18n":{"zh-CN":{"description":"已存在的 Collection 名称。如果设置该值,仅列出分配给该 Collection 的别名;如果不设置,则列出所有数据库中的 Collection 别名。"}}}}},"examples":{"1":{"summary":"example","x-include-target":["milvus"],"value":{"dbName":"default"}},"2":{"summary":"example","x-include-target":["zilliz"],"value":{}}}}}},"responses":{"200":{"description":"A list of collection aliases. ","x-i18n":{"zh-CN":{"description":"返回 Collection 别名列表。"}},"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","items":{"type":"string","description":"A list of item objects.","x-i18n":{"zh-CN":{"description":"对象列表。"}}},"description":"Response payload which is a list of item objects.","x-i18n":{"zh-CN":{"description":"响应载荷,为元素对象列表。"}}}}},{"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":["bob"]}},"2":{"summary":"failure","x-target-response":"OPTION 2","value":{"code":0,"message":"The token is illegal."}}}}}}},"security":[]} +export const specs = {"summary":"List Aliases","deprecated":false,"description":"This operation lists all existing collection aliases in the specified databaseZilliz Cloud cluster.","x-i18n":{"zh-CN":{"summary":"查看 Alias 列表","description":"本接口可列出指定数据库 Zilliz Cloud 集群中的所有 Collection 别名。"}},"tags":["Alias 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 an existing database.","default":"default","x-i18n":{"zh-CN":{"description":"已存在的数据库名称。"}},"x-include-target":["milvus"]},"collectionName":{"type":"string","description":"The name of an existing collection. If specified, only returns aliases of the specified collection. If not specified, returns aliases of all collections in the database.","default":"default","x-i18n":{"zh-CN":{"description":"已存在的 Collection 名称。若指定,仅返回该 Collection 的所有 Alias。若不指定将返回所有 Alias。"}}}}},"examples":{"1":{"summary":"example","x-include-target":["milvus"],"value":{"dbName":"default"}},"2":{"summary":"example","x-include-target":["zilliz"],"value":{}}}}}},"responses":{"200":{"description":"A list of collection aliases. ","x-i18n":{"zh-CN":{"description":"返回 Collection 别名列表。"}},"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","items":{"type":"string","description":"A list of item objects.","x-i18n":{"zh-CN":{"description":"对象列表。"}}},"description":"Response payload which is a list of item objects.","x-i18n":{"zh-CN":{"description":"响应载荷,为元素对象列表。"}}}}},{"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":["bob"]}},"2":{"summary":"failure","x-target-response":"OPTION 2","value":{"code":0,"message":"The token is illegal."}}}}}}},"security":[]} export const endpoint = "/v2/vectordb/aliases/list" export const method = "post" diff --git a/API_Reference_MDX/milvus-restful/v2.4.x/v2/Collection (v2)/Create.mdx b/API_Reference_MDX/milvus-restful/v2.4.x/v2/Collection (v2)/Create.mdx index f1fb09829..824dd5652 100644 --- a/API_Reference_MDX/milvus-restful/v2.4.x/v2/Collection (v2)/Create.mdx +++ b/API_Reference_MDX/milvus-restful/v2.4.x/v2/Collection (v2)/Create.mdx @@ -15,6 +15,6 @@ import RestSpecs from '@site/src/components/RestSpecs'; -export const specs = {"summary":"Create Collection","deprecated":false,"description":"This operation creates a collection in a specified cluster.","x-i18n":{"zh-CN":{"summary":"创建 Collection","description":"本接口可在指定集群中创建 Collection。"}},"tags":["Collection 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":{"description":"Creates a collection in either the quick-setup mode or the custom-setup mode. \n\nIn the quick-setup mode, the schema of the created collection has two schema-defined fields named `id` and `vector` and enabled the dynamic field feature. \n\nIn the custom-setup mode, the schema is defined by the user and the dynamic field feature is disabled by default.","x-i18n":{"zh-CN":{"description":"支持使用快速建表方式和自定义建表方式创建 Collection。\n\n在快速建表方式下,创建的 Collection 具有两个由 Schema 定义的字段 `id` 和 `vector`,并启用了动态字段功能。\n\n在自定义建表方式下,用户可以自定义 Collection 的 Schema,并默认禁用了动态字段功能。"}},"oneOf":[{"x-tab-label":"quick setup","type":"object","properties":{"dbName":{"type":"string","description":"The name of the database.","x-i18n":{"zh-CN":{"description":"数据库名称。"}},"x-include-target":["milvus"]},"collectionName":{"type":"string","description":"The name of the collection to create.","x-i18n":{"zh-CN":{"description":"待创建 Collection 的名称。"}}},"dimension":{"type":"integer","description":"The number of dimensions a vector value should have.\nThis is required if **dtype** of this field is set to **DataType.FLOAT_VECTOR** or **DataType.Binary_VECTOR.","x-i18n":{"zh-CN":{"description":"向量值的维度数。\n若该字段的 **dtype** 为 **DataType.FLOAT_VECTOR** 或 **DataType.Binary_VECTOR**,则该字段为必填项。"}}},"metricType":{"type":"string","description":"The metric type applied to this operation.","x-i18n":{"zh-CN":{"description":"当前 Collection 的度量类型。"}},"enum":["L2","IP","COSINE","JACCARD","HAMMING"],"default":"COSINE"},"idType":{"type":"string","description":"The data type of the primary field. This parameter is designed for the quick-setup of a collection and will be ignored if __schema__ is defined.","x-i18n":{"zh-CN":{"description":"主键字段数据类型。该参数为快速创建 Collection 而设计,若您已定义 __schema__ 字段,则该参数将被忽略。"}}},"autoID":{"type":"boolean","default":"false","description":"Whether the primary field automatically increments. This parameter is designed for the quick-setup of a collection and will be ignored if __schema__ is defined.","x-i18n":{"zh-CN":{"description":"主键是否自动增长。该参数为快速创建 Collection 而设计,若您已定义 __schema__ 字段,则该参数将被忽略。"}}},"primaryFieldName":{"type":"string","description":"The name of the primary field. This parameter is designed for the quick-setup of a collection and will be ignored if __schema__ is defined.","x-i18n":{"zh-CN":{"description":"主键字段名称。该参数为快速创建 Collection 而设计,若您已定义 __schema__ 字段,则该参数将被忽略。"}}},"vectorFieldName":{"type":"string","description":"The name of the vector field. This parameter is designed for the quick-setup of a collection and will be ignored if __schema__ is defined.","x-i18n":{"zh-CN":{"description":"向量字段名称。该参数为快速创建 Collection 而设计,若您已定义 __schema__ 字段,则该参数将被忽略。"}}}},"required":["collectionName"]},{"x-tab-label":"custom setup","type":"object","properties":{"dbName":{"type":"string","description":"The name of the database.","x-i18n":{"zh-CN":{"description":"数据库名称。"}},"x-include-target":["milvus"]},"collectionName":{"type":"string","description":"The name of the collection to create.","x-i18n":{"zh-CN":{"description":"待创建 Collection 的名称。"}}},"schema":{"description":"The schema is responsible for organizing data in the target collection. A valid schema should have multiple fields, which must include a primary key, a vector field, and several scalar fields. Setting this parameter means that `dimension`, `idType`, `autoID`, `primaryFieldName`, and `vectorFieldName` will be ignored.","x-i18n":{"zh-CN":{"description":"Schema 决定了 Collection 中数据的组织方式。一个有效的 Schema 应包含多个字段,其中必须包含主键字段、向量字段以及多个标量字段。设置本参数时,`dimension`、 `idType`、`autoID`、`primaryFieldName`、`vectorFieldName` 等参数将被忽略。"}},"type":"object","properties":{"autoID":{"type":"boolean","description":"Whether allows the primary field to automatically increment. Setting this to True makes the primary field automatically increment. In this case, the primary field should not be included in the data to insert to avoid errors. Set this parameter in the field with is_primary set to True.","x-i18n":{"zh-CN":{"description":"是否允许主键字段自动增长。将该参数设置为 `True` 则主键字段将自动增长。在这种情况下,请不要在插入数据时包含主键字段,以避免错误。如果当前字段的 `is_primary` 参数设置为 `True`,则本参数为必填项。"}}},"enableDynamicField":{"type":"boolean","description":"Whether allows to use the reserved __$meta__ field to hold non-schema-defined fields in key-value pairs.","x-i18n":{"zh-CN":{"description":"是否允许使用保留字段 __$meta__ 来保存 Schema 中未定义的字段。"}}},"fields":{"type":"array","items":{"description":"A field object","type":"object","properties":{"fieldName":{"type":"string","description":"The name of the field to create in the target collection","x-i18n":{"zh-CN":{"description":"目标 Collection 中待创建的字段名称。"}}},"dataType":{"type":"string","description":"The data type of the field values.","x-i18n":{"zh-CN":{"description":"字段值的数据类型。"}},"enum":["BOOL","INT8","INT16","INT32","INT64","FLOAT","DOUBLE","VARCHAR","ARRAY","JSON","BINARY_VECTOR","FLOAT_VECTOR","FLOAT16_VECTOR","BFLOAT16_VECTOR","SPARSE_FLOAT_VECTOR"]},"elementDataType":{"type":"string","description":"The data type of the elements in an array field. This is required if the current field is of the array type.","x-i18n":{"zh-CN":{"description":"数组字段中各元素的数据类型。若当前字段为数组类型,则该参数为必填项。"}},"enum":["BOOL","INT8","INT16","INT32","INT64","FLOAT","DOUBLE","VARCHAR"]},"isPrimary":{"type":"boolean","description":"Whether the current field is the primary field. Setting this to True makes the current field the primary field.","x-i18n":{"zh-CN":{"description":"当前字段是否为主键字段。将该参数设置为 `True` 则当前字段将成为主键字段。此时,还需要确定 `autoID` 参数的取值。"}}},"isPartitionKey":{"type":"boolean","description":"Whether the current field serves as the partition key. Setting this to True makes the current field serve as the partition key. In this case, MilvusZilliz Cloud manages all partitions in the current collection.","x-i18n":{"zh-CN":{"description":"当前字段是否为 Partition Key。将该参数设置为 `True` 则当前字段将作为 Partition Key。在这种情况下,MilvusZilliz Cloud 会管理当前 Collection 中的所有 Partition。"}}},"elementTypeParams":{"type":"object","properties":{"max_length":{"type":"integer","description":"An optional parameter for VarChar values that determines the maximum length of the value in the current field.","x-i18n":{"zh-CN":{"description":"如果当前字段的数据类型为 VarChar,则该参数为必填项,用于设置该字段值的最大长度。"}}},"dim":{"type":"integer","description":"An optional parameter for FloatVector or BinaryVector fields that determines the vector dimension.","x-i18n":{"zh-CN":{"description":"如果当前字段的数据类型为 FloatVector 或 BinaryVector,则该参数为必填项,用于设置向量维度。"}}},"max_capacity":{"type":"integer","description":"An optional parameter for Array field values that determines the maximum number of elements in the current array field.","x-i18n":{"zh-CN":{"description":"如果当前字段的数据类型为 Array,则该参数为必填项,用于设置该字段值的最大元素数量。"}}}},"description":"Extra field parameters.","x-i18n":{"zh-CN":{"description":"字段附加参数。"}}}},"required":["fieldName","dataType","elementTypeParams"]},"description":"A list of field objects.","x-i18n":{"zh-CN":{"description":"字段列表。"}}}},"required":["fields"]},"indexParams":{"type":"array","items":{"type":"object","properties":{"metricType":{"type":"string","description":"The similarity metric type used to build the index. For more information, refer to Similarity Metrics Explained](/docs/search-metrics-explained)Similarity Metrics](https://milvus.io/docs/metric.md).","x-i18n":{"zh-CN":{"description":"用于构建索引的相似度类型。更多详情,请参考相似度指标详解相似度指标](https://milvus.io/docs/metric.md)。"}},"enum":["L2","IP","COSINE","JACCARD","HAMMING"],"default":"COSINE"},"fieldName":{"type":"string","description":"The name of the target field on which an index is to be created.","x-i18n":{"zh-CN":{"description":"要创建索引的目标字段名称。"}}},"indexName":{"type":"string","description":"The name of the index to create. The value defaults to the target field name.","x-i18n":{"zh-CN":{"description":"要创建的索引名称。该值默认为目标字段名称。"}}},"params":{"description":"The index type and related settings. For details, refer to [Vector Indexes](https://milvus.io/docs/index.md).For Zilliz Cloud clusters, you should always set `index_type` to `AUTOINDEX`.","x-i18n":{"zh-CN":{"description":"索引类型及相关设置。详细信息请参考[向量索引](https://milvus.io/docs/index.md)对于 Zilliz Cloud 集群而言,请始终将 `index_type` 设置成 `AUTOINDEX`。"}},"type":"object","properties":{"index_type":{"type":"string","description":"The type of the index to create","x-i18n":{"zh-CN":{"description":"要创建的索引类型。对于 Zilliz Cloud 集群而言,请始终将 `index_type` 设置成 `AUTOINDEX`"}}},"M":{"type":"integer","description":"The maximum degree of the node. This applies only when **index_type** is set to __HNSW__.","x-i18n":{"zh-CN":{"description":"数据节点与其他节点连接的边数。此参数仅适用于**索引类型**为 __HNSW__ 的情况。"}},"x-include-target":["milvus"]},"efConstruction":{"type":"integer","description":"The search scope. This applies only when **index_type** is set to __HNSW__.","x-i18n":{"zh-CN":{"description":"搜索范围。此参数仅适用于**索引类型**为 __HNSW__ 的情况。"}},"x-include-target":["milvus"]},"nlist":{"type":"integer","description":"The number of cluster units. This applies only when **index_type** is set to __IVF-related__ index types.","x-i18n":{"zh-CN":{"description":"数据集群单元的数量。此参数仅适用于**索引类型**为 __IVF__ 系列索引的情况。"}},"x-include-target":["milvus"]}},"x-i18n-langs":["zh-CN"]}},"x-i18n-langs":["zh-CN"],"required":["metricType","fieldName","indexName"]},"description":"The parameters that apply to the index-building process.","x-i18n":{"zh-CN":{"description":"索引构建所需相关参数。"}}},"params":{"description":"Extra parameters for the collection.","x-i18n":{"zh-CN":{"description":"创建 Collection 的附加参数。"}},"type":"object","properties":{"max_length":{"type":"integer","description":"The maximum number of characters in a VarChar field. This parameter is mandatory when the current field type is VarChar.","x-i18n":{"zh-CN":{"description":"设置 VarChar 字段的最大长度。如果当前字段类型为 VarChar 时,该参数为必填项。"}}},"enableDynamicField":{"type":"boolean","description":"Whether to enable the reserved dynamic field. If set to true, non-schema-defined fields are saved in the reserved dynamic field as key-value pairs.","x-i18n":{"zh-CN":{"description":"是否启用保留的动态字段。如果设置为 `true`,则非 Schema 定义的字段将以键值对的形式保存被保存到保留的动态字段中。"}}},"shardsNum":{"type":"integer","description":"The number of shards to create along with the current collection.","x-i18n":{"zh-CN":{"description":"随当前 Collection 创建的 Shard 数量。"}},"x-include-target":["milvus"]},"consistencyLevel":{"type":"integer","description":"The consistency level of the collection.","x-i18n":{"zh-CN":{"description":"当前 Collection 的一致性级别。"}},"enum":["STRONG","BOUNDED","SESSION","EVENTUALLY"]},"partitionsNum":{"type":"integer","description":"The number of partitions to create along with the current collection. This parameter is mandatory if one field of the collection has been designated as the partition key.","x-i18n":{"zh-CN":{"description":"随当前 Collection 创建的 Partition 数量。如果当前 Collection 中有指定为 Partition Key 的字段,则该参数为必填项。"}}},"ttlSeconds":{"type":"integer","description":"The time-to-live (TTL) period of the collection. If set, the collection is to be dropped once the period ends.","x-i18n":{"zh-CN":{"description":"当前 Collection 的 TTL 时间。如果设置,则在 TTL 时间结束后,该 Collection 将被删除。"}}},"partitionKeyIsolation":{"type":"boolean","description":"Whether to enable partition key isolation. For details, refer to [Use Partition Key](https://docs.zilliz.com/docs/use-partition-key).","x-i18n":{"zh-CN":{"description":"是否开启 Partition Key Isolation。详情请参考[使用 Partition Key](https://docs.zilliz.com.cn/docs/use-partition-key)。"}},"x-include-target":["zilliz"]}}}}}],"required":["collectionName"]},"examples":{"1":{"summary":"Quick setup","x-target-request":"OPTION 1","value":{"collectionName":"test_collection","dimension":5}},"2":{"summary":"Quick setup with custom fields","x-target-request":"OPTION 1","value":{"collectionName":"custom_quick_setup","dimension":5,"primaryFieldName":"my_id","idType":"VarChar","vectorFieldName":"my_vector","metric_type":"L2","autoId":true,"params":{"max_length":"512"}}},"3":{"summary":"Custom setup","x-target-request":"OPTION 2","value":{"collectionName":"custom_setup","schema":{"autoId":false,"enabledDynamicField":false,"fields":[{"fieldName":"my_id","dataType":"Int64","isPrimary":true},{"fieldName":"my_vector","dataType":"FloatVector","elementTypeParams":{"dim":"5"}}]}}},"4":{"summary":"Custom setup with index","x-target-request":"OPTION 2","x-include-target":["zilliz"],"value":{"collectionName":"custom_setup_indexed","schema":{"autoId":false,"enabledDynamicField":false,"fields":[{"fieldName":"my_id","dataType":"Int64","isPrimary":true},{"fieldName":"my_vector","dataType":"FloatVector","elementTypeParams":{"dim":"5"}}]},"indexParams":[{"fieldName":"my_vector","metricType":"COSINE","indexName":"my_vector","params":{"index_type":"AUTOINDEX"}},{"fieldName":"my_id","indexName":"my_id","params":{"index_type":"STL_SORT"}}]}},"5":{"summary":"Custom setup with index","x-target-request":"OPTION 2","x-include-target":["milvus"],"value":{"collectionName":"custom_setup_indexed","schema":{"autoId":false,"enabledDynamicField":false,"fields":[{"fieldName":"my_id","dataType":"Int64","isPrimary":true},{"fieldName":"my_vector","dataType":"FloatVector","elementTypeParams":{"dim":"5"}}]},"indexParams":[{"fieldName":"my_vector","metricType":"COSINE","indexName":"my_vector","params":{"index_type":"IVF_FLAT","nlist":1024}},{"fieldName":"my_id","indexName":"my_id","params":{"index_type":"STL_SORT"}}]}}}}}},"responses":{"200":{"description":"Returns a collection object.","x-i18n":{"zh-CN":{"description":"返回 Collection 对象。"}},"content":{"application/json":{"schema":{"anyOf":[{"x-tab-label":"success","type":"object","properties":{"code":{"type":"integer","description":"Response code.","x-i18n":{"zh-CN":{"description":"响应码。"}}},"data":{"type":"object","description":"Response payload which is an empty object.","x-i18n":{"zh-CN":{"description":"响应负载,为空对象。"}},"properties":{}}}},{"x-tab-label":"failure","description":"A failure response.","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":{}}},"2":{"summary":"failure","x-target-response":"OPTION 2","value":{"code":0,"message":"The token is illegal."}}}}}}},"security":[]} +export const specs = {"summary":"Create Collection","deprecated":false,"description":"This operation creates a collection in a specified cluster.","x-i18n":{"zh-CN":{"summary":"创建 Collection","description":"本接口可在指定集群中创建 Collection。"}},"tags":["Collection 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":{"description":"Creates a collection in either the quick-setup mode or the custom-setup mode. \n\nIn the quick-setup mode, the schema of the created collection has two schema-defined fields named `id` and `vector` and enabled the dynamic field feature. \n\nIn the custom-setup mode, the schema is defined by the user and the dynamic field feature is disabled by default.","x-i18n":{"zh-CN":{"description":"支持使用快速建表方式和自定义建表方式创建 Collection。\n\n在快速建表方式下,创建的 Collection 具有两个由 Schema 定义的字段 `id` 和 `vector`,并启用了动态字段功能。\n\n在自定义建表方式下,用户可以自定义 Collection 的 Schema,并默认禁用了动态字段功能。"}},"oneOf":[{"x-tab-label":"quick setup","type":"object","properties":{"dbName":{"type":"string","description":"The name of the database.","x-i18n":{"zh-CN":{"description":"数据库名称。"}},"x-include-target":["milvus"]},"collectionName":{"type":"string","description":"The name of the collection to create.","x-i18n":{"zh-CN":{"description":"待创建 Collection 的名称。"}}},"dimension":{"type":"integer","description":"The number of dimensions a vector value should have.\nThis is required if **dtype** of this field is set to **DataType.FLOAT_VECTOR** or **DataType.Binary_VECTOR.","x-i18n":{"zh-CN":{"description":"向量值的维度数。\n若该字段的 **dtype** 为 **DataType.FLOAT_VECTOR** 或 **DataType.Binary_VECTOR,则该字段为必填项。"}}},"metricType":{"type":"string","description":"The metric type applied to this operation.","x-i18n":{"zh-CN":{"description":"当前 Collection 的度量类型。"}},"enum":["L2","IP","COSINE"],"default":"COSINE"},"idType":{"type":"string","description":"The data type of the primary field. This parameter is designed for the quick-setup of a collection and will be ignored if __schema__ is defined.","x-i18n":{"zh-CN":{"description":"主键字段数据类型。该参数为快速创建 Collection 而设计,若您已定义 __schema__ 字段,则该参数将被忽略。"}}},"autoID":{"type":"string","default":"false","description":"Whether the primary field automatically increments. This parameter is designed for the quick-setup of a collection and will be ignored if __schema__ is defined.","x-i18n":{"zh-CN":{"description":"主键是否自动增长。该参数为快速创建 Collection 而设计,若您已定义 __schema__ 字段,则该参数将被忽略。"}}},"primaryFieldName":{"type":"string","description":"The name of the primary field. This parameter is designed for the quick-setup of a collection and will be ignored if __schema__ is defined.","x-i18n":{"zh-CN":{"description":"主键字段名称。该参数为快速创建 Collection 而设计,若您已定义 __schema__ 字段,则该参数将被忽略。"}}},"vectorFieldName":{"type":"string","description":"The name of the vector field. This parameter is designed for the quick-setup of a collection and will be ignored if __schema__ is defined.","x-i18n":{"zh-CN":{"description":"向量字段名称。该参数为快速创建 Collection 而设计,若您已定义 __schema__ 字段,则该参数将被忽略。"}}}},"required":["collectionName","dimension"]},{"x-tab-label":"custom setup","type":"object","properties":{"dbName":{"type":"string","description":"The name of the database.","x-i18n":{"zh-CN":{"description":"数据库名称。"}},"x-include-target":["milvus"]},"collectionName":{"type":"string","description":"The name of the collection to create.","x-i18n":{"zh-CN":{"description":"待创建 Collection 的名称。"}}},"schema":{"description":"The schema is responsible for organizing data in the target collection. A valid schema should have multiple fields, which must include a primary key, a vector field, and several scalar fields. Setting this parameter means that `dimension`, `idType`, `autoID`, `primaryFieldName`, and `vectorFieldName` will be ignored.","x-i18n":{"zh-CN":{"description":"Schema 决定了 Collection 中数据的组织方式。一个有效的 Schema 应包含多个字段,其中必须包含主键字段、向量字段以及多个标量字段。设置本参数时,`dimension`、 `idType`、`autoID`、`primaryFieldName`、`vectorFieldName` 等参数将被忽略。"}},"type":"object","properties":{"autoID":{"type":"string","description":"Whether allows the primary field to automatically increment. Setting this to True makes the primary field automatically increment. In this case, the primary field should not be included in the data to insert to avoid errors. Set this parameter in the field with is_primary set to True.","x-i18n":{"zh-CN":{"description":"是否允许主键字段自动增长。将该参数设置为 `True` 则主键字段将自动增长。在这种情况下,请不要在插入数据时包含主键字段,以避免错误。如果当前字段的 `is_primary` 参数设置为 `True`,则本参数为必填项。"}}},"enableDynamicField":{"type":"string","description":"Whether allows to use the reserved __$meta__ field to hold non-schema-defined fields in key-value pairs.","x-i18n":{"zh-CN":{"description":"是否允许使用保留字段 __$meta__ 来保存 Schema 中未定义的字段。"}}},"fields":{"type":"array","items":{"description":"A field object","type":"object","properties":{"fieldName":{"type":"string","description":"The name of the field to create in the target collection","x-i18n":{"zh-CN":{"description":"目标 Collection 中待创建的字段名称。"}}},"dataType":{"type":"string","description":"The data type of the field values.","x-i18n":{"zh-CN":{"description":"字段值的数据类型。"}},"enum":["DataType.BOOL","DataType.INT8","DataType.INT16","DataType.INT32","DataType.INT64","DataType.FLOAT","DataType.DOUBLE","DataType.VARCHAR","DataType.ARRAY","DataType.JSON","DataType.BINARY_VECTOR","DataType.FLOAT_VECTOR","DataType.FLOAT16_VECTOR","DataType.BFLOAT16_VECTOR","DataType.SPARSE_FLOAT_VECTOR"]},"elementDataType":{"type":"string","description":"The data type of the elements in an array field. This is required if the current field is of the array type.","x-i18n":{"zh-CN":{"description":"数组字段中各元素的数据类型。若当前字段为数组类型,则该参数为必填项。"}},"enum":["DataType.BOOL","DataType.INT8","DataType.INT16","DataType.INT32","DataType.INT64","DataType.FLOAT","DataType.DOUBLE","DataType.VARCHAR"]},"isPrimary":{"type":"boolean","description":"Whether the current field is the primary field. Setting this to True makes the current field the primary field.","x-i18n":{"zh-CN":{"description":"当前字段是否为主键字段。将该参数设置为 `True` 则当前字段将成为主键字段。此时,还需要确定 `autoID` 参数的取值。"}}},"isPartitionKey":{"type":"boolean","description":"Whether the current field serves as the partition key. Setting this to True makes the current field serve as the partition key. In this case, MilvusZilliz Cloud manages all partitions in the current collection.","x-i18n":{"zh-CN":{"description":"当前字段是否为 Partition Key。将该参数设置为 `True` 则当前字段将作为 Partition Key。在这种情况下,MilvusZilliz Cloud 会管理当前 Collection 中的所有 Partition。"}}},"elementTypeParams":{"type":"object","properties":{"max_length":{"type":"integer","description":"An optional parameter for VarChar values that determines the maximum length of the value in the current field.","x-i18n":{"zh-CN":{"description":"如果当前字段的数据类型为 VarChar,则该参数为必填项,用于设置该字段值的最大长度。"}}},"dim":{"type":"integer","description":"An optional parameter for FloatVector or BinaryVector fields that determines the vector dimension.","x-i18n":{"zh-CN":{"description":"如果当前字段的数据类型为 FloatVector 或 BinaryVector,则该参数为必填项,用于设置向量维度。"}}},"max_capacity":{"type":"integer","description":"An optional parameter for Array field values that determines the maximum number of elements in the current array field.","x-i18n":{"zh-CN":{"description":"如果当前字段的数据类型为 Array,则该参数为必填项,用于设置该字段值的最大元素数量。"}}}},"description":"Extra field parameters.","x-i18n":{"zh-CN":{"description":"字段附加参数。"}}}},"required":["fieldName","dataType"]},"description":"A list of field objects.","x-i18n":{"zh-CN":{"description":"字段列表。"}}}},"required":["fields"]},"indexParams":{"type":"array","items":{"type":"object","properties":{"metricType":{"type":"string","description":"The similarity metric type used to build the index. For more information, refer to Similarity Metrics Explained](/docs/search-metrics-explained)Similarity Metrics](https://milvus.io/docs/metric.md).","x-i18n":{"zh-CN":{"description":"用于构建索引的相似度类型。更多详情,请参考相似度指标详解相似度指标](https://milvus.io/docs/metric.md)。"}},"enum":["L2","IP","COSINE"],"default":"COSINE"},"fieldName":{"type":"string","description":"The name of the target field on which an index is to be created.","x-i18n":{"zh-CN":{"description":"要创建索引的目标字段名称。"}}},"indexName":{"type":"string","description":"The name of the index to create. The value defaults to the target field name.","x-i18n":{"zh-CN":{"description":"要创建的索引名称。该值默认为目标字段名称。"}}},"params":{"description":"The index type and related settings. For details, refer to [Vector Indexes](https://milvus.io/docs/index.md).For Zilliz Cloud clusters, you should always set `index_type` to `AUTOINDEX`.","x-i18n":{"zh-CN":{"description":"索引类型及相关设置。详细信息请参考[向量索引](https://milvus.io/docs/index.md)对于 Zilliz Cloud 集群而言,请始终将 `index_type` 设置成 `AUTOINDEX`。"}},"type":"object","properties":{"index_type":{"type":"string","description":"The type of the index to create","x-i18n":{"zh-CN":{"description":"要创建的索引类型。对于 Zilliz Cloud 集群而言,请始终将 `index_type` 设置成 `AUTOINDEX`"}}},"M":{"type":"integer","description":"The maximum degree of the node. This applies only when **index_type** is set to __HNSW__.","x-i18n":{"zh-CN":{"description":"数据节点与其他节点连接的边数。此参数仅适用于**索引类型**为 __HNSW__ 的情况。"}},"x-include-target":["milvus"]},"efConstruction":{"type":"integer","description":"The search scope. This applies only when **index_type** is set to __HNSW__.","x-i18n":{"zh-CN":{"description":"搜索范围。此参数仅适用于**索引类型**为 __HNSW__ 的情况。"}},"x-include-target":["milvus"]},"nlist":{"type":"integer","description":"The number of cluster units. This applies only when **index_type** is set to __IVF-related__ index types.","x-i18n":{"zh-CN":{"description":"数据集群单元的数量。此参数仅适用于**索引类型**为 __IVF__ 系列索引的情况。"}},"x-include-target":["milvus"]}},"x-i18n-langs":["zh-CN"],"required":["index_type"]}},"x-i18n-langs":["zh-CN"],"required":["metricType","fieldName","indexName"]},"description":"The parameters that apply to the index-building process.","x-i18n":{"zh-CN":{"description":"索引构建所需相关参数。"}}},"params":{"description":"Extra parameters for the collection.","x-i18n":{"zh-CN":{"description":"创建 Collection 的附加参数。"}},"type":"object","properties":{"max_length":{"type":"integer","description":"The maximum number of characters in a VarChar field. This parameter is mandatory when the current field type is VarChar.","x-i18n":{"zh-CN":{"description":"设置 VarChar 字段的最大长度。如果当前字段类型为 VarChar 时,该参数为必填项。"}}},"enableDynamicField":{"type":"boolean","description":"Whether to enable the reserved dynamic field. If set to true, non-schema-defined fields are saved in the reserved dynamic field as key-value pairs.","x-i18n":{"zh-CN":{"description":"是否启用保留的动态字段。如果设置为 `true`,则非 Schema 定义的字段将以键值对的形式保存被保存到保留的动态字段中。"}}},"shardsNum":{"type":"integer","description":"The number of shards to create along with the current collection.","x-i18n":{"zh-CN":{"description":"随当前 Collection 创建的 Shard 数量。"}},"x-include-target":["milvus"]},"consistencyLevel":{"type":"integer","description":"The consistency level of the collection.","x-i18n":{"zh-CN":{"description":"当前 Collection 的一致性级别。"}},"enum":["STRONG","BOUNDED","SESSION","EVENTUALLY"]},"partitionsNum":{"type":"integer","description":"The number of partitions to create along with the current collection. This parameter is mandatory if one field of the collection has been designated as the partition key.","x-i18n":{"zh-CN":{"description":"随当前 Collection 创建的 Partition 数量。如果当前 Collection 中有指定为 Partition Key 的字段,则该参数为必填项。"}}},"ttlSeconds":{"type":"integer","description":"The time-to-live (TTL) period of the collection. If set, the collection is to be dropped once the period ends.","x-i18n":{"zh-CN":{"description":"当前 Collection 的 TTL 时间。如果设置,则在 TTL 时间结束后,该 Collection 将被删除。"}}}}}}}],"required":["collectionName"]},"examples":{"1":{"summary":"Quick setup","x-target-request":"OPTION 1","value":{"collectionName":"test_collection","dimension":5}},"2":{"summary":"Quick setup with custom fields","x-target-request":"OPTION 1","value":{"collectionName":"custom_quick_setup","dimension":5,"primaryFieldName":"my_id","idType":"VarChar","vectorFieldName":"my_vector","metric_type":"L2","autoId":true,"params":{"max_length":"512"}}},"3":{"summary":"Custom setup","x-target-request":"OPTION 2","value":{"collectionName":"custom_setup","schema":{"autoId":false,"enabledDynamicField":false,"fields":[{"fieldName":"my_id","dataType":"Int64","isPrimary":true},{"fieldName":"my_vector","dataType":"FloatVector","elementTypeParams":{"dim":"5"}}]}}},"4":{"summary":"Custom setup with index","x-target-request":"OPTION 2","x-include-target":["zilliz"],"value":{"collectionName":"custom_setup_indexed","schema":{"autoId":false,"enabledDynamicField":false,"fields":[{"fieldName":"my_id","dataType":"Int64","isPrimary":true},{"fieldName":"my_vector","dataType":"FloatVector","elementTypeParams":{"dim":"5"}}]},"indexParams":[{"fieldName":"my_vector","metricType":"COSINE","indexName":"my_vector","params":{"index_type":"AUTOINDEX"}},{"fieldName":"my_id","indexName":"my_id","params":{"index_type":"STL_SORT"}}]}},"5":{"summary":"Custom setup with index","x-target-request":"OPTION 2","x-include-target":["milvus"],"value":{"collectionName":"custom_setup_indexed","schema":{"autoId":false,"enabledDynamicField":false,"fields":[{"fieldName":"my_id","dataType":"Int64","isPrimary":true},{"fieldName":"my_vector","dataType":"FloatVector","elementTypeParams":{"dim":"5"}}]},"indexParams":[{"fieldName":"my_vector","metricType":"COSINE","indexName":"my_vector","params":{"index_type":"IVF_FLAT","nlist":1024}},{"fieldName":"my_id","indexName":"my_id","params":{"index_type":"STL_SORT"}}]}}}}}},"responses":{"200":{"description":"Returns a collection object.","x-i18n":{"zh-CN":{"description":"返回 Collection 对象。"}},"content":{"application/json":{"schema":{"anyOf":[{"x-tab-label":"success","type":"object","properties":{"code":{"type":"integer","description":"Response code.","x-i18n":{"zh-CN":{"description":"响应码。"}}},"data":{"type":"object","description":"Response payload which is an empty object.","x-i18n":{"zh-CN":{"description":"响应负载,为空对象。"}},"properties":{}}}},{"x-tab-label":"failure","description":"A failure response.","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":{}}},"2":{"summary":"failure","x-target-response":"OPTION 2","value":{"code":0,"message":"The token is illegal."}}}}}}},"security":[]} export const endpoint = "/v2/vectordb/collections/create" export const method = "post" diff --git a/API_Reference_MDX/milvus-restful/v2.4.x/v2/Collection (v2)/Get Load State.mdx b/API_Reference_MDX/milvus-restful/v2.4.x/v2/Collection (v2)/Get Load State.mdx index 6d049f438..5c9d77720 100644 --- a/API_Reference_MDX/milvus-restful/v2.4.x/v2/Collection (v2)/Get Load State.mdx +++ b/API_Reference_MDX/milvus-restful/v2.4.x/v2/Collection (v2)/Get Load State.mdx @@ -15,6 +15,6 @@ import RestSpecs from '@site/src/components/RestSpecs'; -export const specs = {"summary":"Get Collection Load State","deprecated":false,"description":"This operation returns the load status of a specific collection.","x-i18n":{"zh-CN":{"summary":"获取 Collection 加载状态","description":"本接口可以获取指定 Collection 的加载状态。"}},"tags":["Collection 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 a database to which the collection belongs.","x-i18n":{"zh-CN":{"description":"数据库名称。"}},"x-include-target":["milvus"]},"collectionName":{"type":"string","description":"The name of a collection.","x-i18n":{"zh-CN":{"description":"待查询 Collection 名称。"}}},"partitionNames":{"type":"string","description":"A list of partition names. If any partition names are specified, releasing any of these partitions results in the return of a NotLoad state.","x-i18n":{"zh-CN":{"description":"Partition 名称列表。如果指定了 Partition 名称,释放任何一个 Partition 都会导致返回 NotLoad 状态。"}}}},"required":["collectionName"]},"example":{"collectionName":"quick_setup"}}}},"responses":{"200":{"description":"A LoadState object that indicates the load status of the specified collection.","x-i18n":{"zh-CN":{"description":"返回指定 Collection 的加载状态。"}},"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":"A LoadState object that indicates the load status and load progress of the specified collection.","x-i18n":{"zh-CN":{"description":"返回指定 Collection 的加载状态和加载进度。"}},"properties":{"loadState":{"type":"string","description":"An object that indicates the load status of the specified collection.","x-i18n":{"zh-CN":{"description":"指定 Collection 的加载状态。"}}},"loadProgress":{"type":"integer","description":"An integer that indicates the load progress in the percentage of the specified collection.","x-i18n":{"zh-CN":{"description":"指定 Collection 的加载进度。"}}},"message":{"type":"string","description":"Returned message.","x-i18n":{"zh-CN":{"description":"返回的消息。"}}}}}}},{"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":{"loadProgress":100,"loadState":"LoadStateLoaded","message":""}}},"2":{"summary":"failure","x-target-response":"OPTION 2","value":{"code":0,"message":"The token is illegal."}}}}}}},"security":[]} +export const specs = {"summary":"Get Collection Load State","deprecated":false,"description":"This operation returns the load status of a specific collection.","x-i18n":{"zh-CN":{"summary":"查看 Collection 加载状态","description":"本接口可以获取指定 Collection 的加载状态。"}},"tags":["Collection 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 a database to which the collection belongs.","x-i18n":{"zh-CN":{"description":"数据库名称。"}},"x-include-target":["milvus"]},"collectionName":{"type":"string","description":"The name of a collection.","x-i18n":{"zh-CN":{"description":"待查询 Collection 名称。"}}},"partitionNames":{"type":"string","description":"A list of partition names. If any partition names are specified, releasing any of these partitions results in the return of a NotLoad state.","x-i18n":{"zh-CN":{"description":"Partition 名称列表。如果指定了 Partition 名称,释放任何一个 Partition 都会导致返回 NotLoad 状态。"}}}},"required":["collectionName"]},"example":{"collectionName":"quick_setup"}}}},"responses":{"200":{"description":"A LoadState object that indicates the load status of the specified collection.","x-i18n":{"zh-CN":{"description":"返回指定 Collection 的加载状态。"}},"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":"A LoadState object that indicates the load status and load progress of the specified collection.","x-i18n":{"zh-CN":{"description":"返回指定 Collection 的加载状态和加载进度。"}},"properties":{"loadState":{"type":"string","description":"An object that indicates the load status of the specified collection.","x-i18n":{"zh-CN":{"description":"指定 Collection 的加载状态。"}}},"loadProgress":{"type":"integer","description":"An integer that indicates the load progress in the percentage of the specified collection.","x-i18n":{"zh-CN":{"description":"指定 Collection 的加载进度。"}}},"message":{"type":"string","description":"Returned message.","x-i18n":{"zh-CN":{"description":"返回的消息。"}}}}}}},{"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":{"loadProgress":100,"loadState":"LoadStateLoaded","message":""}}},"2":{"summary":"failure","x-target-response":"OPTION 2","value":{"code":0,"message":"The token is illegal."}}}}}}},"security":[]} export const endpoint = "/v2/vectordb/collections/get_load_state" export const method = "post" diff --git a/API_Reference_MDX/milvus-restful/v2.4.x/v2/Collection (v2)/Has.mdx b/API_Reference_MDX/milvus-restful/v2.4.x/v2/Collection (v2)/Has.mdx index ac3377a06..9605b1ed5 100644 --- a/API_Reference_MDX/milvus-restful/v2.4.x/v2/Collection (v2)/Has.mdx +++ b/API_Reference_MDX/milvus-restful/v2.4.x/v2/Collection (v2)/Has.mdx @@ -15,6 +15,6 @@ import RestSpecs from '@site/src/components/RestSpecs'; -export const specs = {"summary":"Has Collection","deprecated":false,"description":"This operation checks whether a collection exists.","x-i18n":{"zh-CN":{"summary":"检查 Collection 是否存在","description":"本接口可检查指定的 Collection 是否存在。"}},"tags":["Collection 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 database in which to check the existence of a collection.","x-i18n":{"zh-CN":{"description":"待检查 Collection 所在数据库名称。"}},"x-include-target":["milvus"]},"collectionName":{"type":"string","description":"The name of an existing collection.","x-i18n":{"zh-CN":{"description":"待检查的 Collection 名称。"}}}},"required":["collectionName"]},"example":{"collectionName":"quick_setup"}}}},"responses":{"200":{"description":"A boolean value indicates whether the specified collection exists.","x-i18n":{"zh-CN":{"description":"返回表示指定 Collection 是否存在的布尔值。"}},"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 carries a boolean value.","x-i18n":{"zh-CN":{"description":"响应负载,携带一个表示指定 Collection 是否存在的布尔值。"}},"properties":{"has":{"type":"boolean","description":"A boolean value indicates whether the specified collection exists.","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":{"has":true}}},"2":{"summary":"failure","x-target-response":"OPTION 2","value":{"code":1802,"message":"reason for failure"}}}}}}},"security":[]} +export const specs = {"summary":"Has Collection","deprecated":false,"description":"This operation checks whether a collection exists.","x-i18n":{"zh-CN":{"summary":"查看 Collection 是否存在","description":"本接口可检查指定的 Collection 是否存在。"}},"tags":["Collection 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 database in which to check the existence of a collection.","x-i18n":{"zh-CN":{"description":"待检查 Collection 所在数据库名称。"}},"x-include-target":["milvus"]},"collectionName":{"type":"string","description":"The name of an existing collection.","x-i18n":{"zh-CN":{"description":"待检查的 Collection 名称。"}}}},"required":["collectionName"]},"example":{"collectionName":"quick_setup"}}}},"responses":{"200":{"description":"A boolean value indicates whether the specified collection exists.","x-i18n":{"zh-CN":{"description":"返回表示指定 Collection 是否存在的布尔值。"}},"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 carries a boolean value.","x-i18n":{"zh-CN":{"description":"响应负载,携带一个表示指定 Collection 是否存在的布尔值。"}},"properties":{"has":{"type":"boolean","description":"A boolean value indicates whether the specified collection exists.","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":{"has":true}}},"2":{"summary":"failure","x-target-response":"OPTION 2","value":{"code":1802,"message":"reason for failure"}}}}}}},"security":[]} export const endpoint = "/v2/vectordb/collections/has" export const method = "post" diff --git a/API_Reference_MDX/milvus-restful/v2.4.x/v2/Partition (v2)/Create.mdx b/API_Reference_MDX/milvus-restful/v2.4.x/v2/Partition (v2)/Create.mdx index 3097763ce..8fea6992d 100644 --- a/API_Reference_MDX/milvus-restful/v2.4.x/v2/Partition (v2)/Create.mdx +++ b/API_Reference_MDX/milvus-restful/v2.4.x/v2/Partition (v2)/Create.mdx @@ -15,6 +15,6 @@ import RestSpecs from '@site/src/components/RestSpecs'; -export const specs = {"summary":"Create Partition","deprecated":false,"description":"This operation creates a partition in a collection.","x-i18n":{"zh-CN":{"summary":"创建 Partition","description":"本接口用于在 Collection 中创建 Partition。"}},"tags":["Partition 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 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"]},"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":{"description":"目标 Collection 的名称。设置为不存在的 Collection 将导致错误。"}}}},"partitionName":{"type":"string","description":"The name of the target parition.","x-i18n":{"zh-CN":{"description":"待创建 Partition 名称。"}}}},"required":["partitionName","collectionName"]},"example":{"partitionName":"january","collectionName":"quick_setup"}}}},"responses":{"200":{"description":"Returns an empty object or an error message.","x-i18n":{"zh-CN":{"description":"返回一个空对象或一条错误消息。"}},"content":{"application/json":{"schema":{"anyOf":[{"x-tab-label":"success","description":"A success response","x-i18n":{"zh-CN":{"description":"成功响应"}},"x-i18n-langs":["zh-CN"],"type":"object","properties":{"code":{"description":"Response code.","x-i18n":{"zh-CN":{"description":"响应码。"}},"type":"integer","example":0},"data":{"type":"object","properties":{},"description":"Response payload which is an empty object.","x-i18n":{"zh-CN":{"description":"响应载荷。为空对象。"}}}}},{"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":{}}},"2":{"summary":"failure","x-target-response":"OPTION 2","value":{"code":0,"message":"The token is illegal."}}}}}}},"security":[]} +export const specs = {"summary":"Create Partition","deprecated":false,"description":"This operation creates a partition in a collection.","x-i18n":{"zh-CN":{"summary":"创建 Partition","description":"本接口用于在 Collection 中创建 Partition。"}},"tags":["Partition 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 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"]},"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 parition.","x-i18n":{"zh-CN":{"description":"待创建 Partition 名称。"}}}},"required":["partitionName","collectionName"]},"example":{"partitionName":"january","collectionName":"quick_setup"}}}},"responses":{"200":{"description":"Returns an empty object or an error message.","x-i18n":{"zh-CN":{"description":"返回一个空对象或一条错误消息。"}},"content":{"application/json":{"schema":{"anyOf":[{"x-tab-label":"success","description":"A success response","x-i18n":{"zh-CN":{"description":"成功响应"}},"x-i18n-langs":["zh-CN"],"type":"object","properties":{"code":{"description":"Response code.","x-i18n":{"zh-CN":{"description":"响应码。"}},"type":"integer","example":0},"data":{"type":"object","properties":{},"description":"Response payload which is an empty object.","x-i18n":{"zh-CN":{"description":"响应载荷。为空对象。"}}}}},{"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":{}}},"2":{"summary":"failure","x-target-response":"OPTION 2","value":{"code":0,"message":"The token is illegal."}}}}}}},"security":[]} export const endpoint = "/v2/vectordb/partitions/create" export const method = "post" diff --git a/API_Reference_MDX/milvus-restful/v2.4.x/v2/Partition (v2)/Get Statistics.mdx b/API_Reference_MDX/milvus-restful/v2.4.x/v2/Partition (v2)/Get Statistics.mdx index c85088d19..029b7aca0 100644 --- a/API_Reference_MDX/milvus-restful/v2.4.x/v2/Partition (v2)/Get Statistics.mdx +++ b/API_Reference_MDX/milvus-restful/v2.4.x/v2/Partition (v2)/Get Statistics.mdx @@ -15,6 +15,6 @@ import RestSpecs from '@site/src/components/RestSpecs'; -export const specs = {"summary":"Get Partition Statistics","deprecated":false,"description":"This operations gets the number of entities in a partition.","x-i18n":{"zh-CN":{"summary":"查看 Partition 统计","description":"本接口可以查看指定 Partition 中存放的 Entity 数量。"}},"tags":["Partition 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 an existing database.","default":"default","x-i18n":{"zh-CN":{"description":"数据库名称。"}},"x-include-target":["milvus"]},"collectionName":{"type":"string","description":"The name of an existing collection.","x-i18n":{"zh-CN":{"description":"Collection 名称。"}}},"partitionName":{"type":"string","description":"The name of the target partition of this operation. ","x-i18n":{"zh-CN":{"description":"待查看的 Partition 名称。"}}}},"required":["partitionName","collectionName"]},"example":{"partitionName":"january","collectionName":"quick_setup"}}}},"responses":{"200":{"description":"Returns the number of entities in the specified collection.","x-i18n":{"zh-CN":{"description":"返回指定 Partition 中存放的 Entity 数量。"}},"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":"Statistics of the specified partition.","x-i18n":{"zh-CN":{"description":"指定 Partition 的统计信息。"}},"properties":{"rowCount":{"type":"integer","description":"The number of entities.","x-i18n":{"zh-CN":{"description":"Entity 数量。"}}}}}}},{"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":{"rowCount":0}}},"2":{"summary":"failure","x-target-response":"OPTION 2","value":{"code":0,"message":"The token is illegal."}}}}}}},"security":[]} +export const specs = {"summary":"Get Partition Statistics","deprecated":false,"description":"This operations gets the number of entities in a partition.","x-i18n":{"zh-CN":{"summary":"查看 Partition 统计信息","description":"本接口可以查看指定 Partition 中存放的 Entity 数量。"}},"tags":["Partition 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 an existing database.","default":"default","x-i18n":{"zh-CN":{"description":"数据库名称。"}},"x-include-target":["milvus"]},"collectionName":{"type":"string","description":"The name of an existing collection.","x-i18n":{"zh-CN":{"description":"Collection 名称。"}}},"partitionName":{"type":"string","description":"The name of the target partition of this operation. ","x-i18n":{"zh-CN":{"description":"待查看的 Partition 名称。"}}}},"required":["partitionName","collectionName"]},"example":{"partitionName":"january","collectionName":"quick_setup"}}}},"responses":{"200":{"description":"Returns the number of entities in the specified collection.","x-i18n":{"zh-CN":{"description":"返回指定 Partition 中存放的 Entity 数量。"}},"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":"Statistics of the specified partition.","x-i18n":{"zh-CN":{"description":"指定 Partition 的统计信息。"}},"properties":{"rowCount":{"type":"integer","description":"The number of entities.","x-i18n":{"zh-CN":{"description":"Entity 数量。"}}}}}}},{"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":{"rowCount":0}}},"2":{"summary":"failure","x-target-response":"OPTION 2","value":{"code":0,"message":"The token is illegal."}}}}}}},"security":[]} export const endpoint = "/v2/vectordb/partitions/get_stats" export const method = "post" diff --git a/API_Reference_MDX/milvus-restful/v2.4.x/v2/Partition (v2)/Has.mdx b/API_Reference_MDX/milvus-restful/v2.4.x/v2/Partition (v2)/Has.mdx index 57a640056..16bece5b5 100644 --- a/API_Reference_MDX/milvus-restful/v2.4.x/v2/Partition (v2)/Has.mdx +++ b/API_Reference_MDX/milvus-restful/v2.4.x/v2/Partition (v2)/Has.mdx @@ -15,6 +15,6 @@ import RestSpecs from '@site/src/components/RestSpecs'; -export const specs = {"summary":"Has Partition","deprecated":false,"description":"This operation checks whether a partition exists.","x-i18n":{"zh-CN":{"summary":"检查 Partition 是否存在","description":"本接口可检查指定的 Partition 是否存在。"}},"tags":["Partition 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 an existing database.","x-i18n":{"zh-CN":{"description":"数据库名称。"}},"default":"_default","x-include-target":["milvus"]},"collectionName":{"type":"string","description":"The name of an existing collection.","x-i18n":{"zh-CN":{"description":"Collection 名称。"}}},"partitionName":{"type":"string","description":"The name of the partition to test.","x-i18n":{"zh-CN":{"description":"待检查的 Partition 名称。"}}}},"required":["partitionName","collectionName"]},"example":{"partitionName":"january","collectionName":"test_collection"}}}},"responses":{"200":{"description":"A boolean value indicating whether the specified partition exists.","x-i18n":{"zh-CN":{"description":"返回一个表示指定 Partition 是否存在的布尔值。"}},"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 carries a boolean value.","x-i18n":{"zh-CN":{"description":"响应负载,携带表示指定 Partition 是否存在的布尔值。"}},"properties":{"has":{"type":"boolean","description":"A boolean value indicates whether the specified partition exists.","x-i18n":{"zh-CN":{"description":"表示指定 Partition 是否存在的布尔值。"}}}}}}},{"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":{"has":true}}},"2":{"summary":"failure","x-target-response":"OPTION 2","value":{"code":0,"message":"The token is illegal."}}}}}}},"security":[]} +export const specs = {"summary":"Has Partition","deprecated":false,"description":"This operation checks whether a partition exists.","x-i18n":{"zh-CN":{"summary":"查看 Partition 是否存在","description":"本接口可检查指定的 Partition 是否存在。"}},"tags":["Partition 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 an existing database.","x-i18n":{"zh-CN":{"description":"数据库名称。"}},"default":"_default","x-include-target":["milvus"]},"collectionName":{"type":"string","description":"The name of an existing collection.","x-i18n":{"zh-CN":{"description":"Collection 名称。"}}},"partitionName":{"type":"string","description":"The name of the partition to test.","x-i18n":{"zh-CN":{"description":"待检查的 Partition 名称。"}}}},"required":["partitionName","collectionName"]},"example":{"partitionName":"january","collectionName":"test_collection"}}}},"responses":{"200":{"description":"A boolean value indicating whether the specified partition exists.","x-i18n":{"zh-CN":{"description":"返回一个表示指定 Partition 是否存在的布尔值。"}},"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 carries a boolean value.","x-i18n":{"zh-CN":{"description":"响应负载,携带表示指定 Partition 是否存在的布尔值。"}},"properties":{"has":{"type":"boolean","description":"A boolean value indicates whether the specified partition exists.","x-i18n":{"zh-CN":{"description":"表示指定 Partition 是否存在的布尔值。"}}}}}}},{"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":{"has":true}}},"2":{"summary":"failure","x-target-response":"OPTION 2","value":{"code":0,"message":"The token is illegal."}}}}}}},"security":[]} export const endpoint = "/v2/vectordb/partitions/has" export const method = "post" diff --git a/API_Reference_MDX/milvus-restful/v2.4.x/v2/Partition (v2)/Load.mdx b/API_Reference_MDX/milvus-restful/v2.4.x/v2/Partition (v2)/Load.mdx index a78a0fb6d..2c4173831 100644 --- a/API_Reference_MDX/milvus-restful/v2.4.x/v2/Partition (v2)/Load.mdx +++ b/API_Reference_MDX/milvus-restful/v2.4.x/v2/Partition (v2)/Load.mdx @@ -15,6 +15,6 @@ import RestSpecs from '@site/src/components/RestSpecs'; -export const specs = {"summary":"Load Partitions","deprecated":false,"description":"This operation loads the data of the current partition into memory.","x-i18n":{"zh-CN":{"summary":"加载 Partitions","description":"本接口将指定 Partition 中的数据加载到内存。"}},"tags":["Partition 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 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"]},"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 将导致错误。"}}},"partitionNames":{"type":"array","items":{"type":"string","description":"A partition name.","x-i18n":{"zh-CN":{"description":"Partition 名称。"}}},"description":"The list of names of the target partitions.","x-i18n":{"zh-CN":{"description":"目标 Partition 名称列表。"}}}},"required":["partitionNames","collectionName"]},"example":{"collectionName":"medium_articles","partitionNames":["partition_1","partition_2"]}}}},"responses":{"200":{"description":"Return an empty object or an error message.","content":{"application/json":{"schema":{"anyOf":[{"x-tab-label":"success","description":"A success response","x-i18n":{"zh-CN":{"description":"成功响应"}},"x-i18n-langs":["zh-CN"],"type":"object","properties":{"code":{"description":"Response code.","x-i18n":{"zh-CN":{"description":"响应码。"}},"type":"integer","example":0},"data":{"type":"object","properties":{},"description":"Response payload which is an empty object.","x-i18n":{"zh-CN":{"description":"响应载荷。为空对象。"}}}}},{"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":{}}},"2":{"summary":"failure","x-target-response":"OPTION 2","value":{"code":0,"message":"The token is illegal."}}}}}}},"security":[]} +export const specs = {"summary":"Load Partitions","deprecated":false,"description":"This operation loads the data of the current partition into memory.","x-i18n":{"zh-CN":{"summary":"加载 Partition","description":"本接口将指定 Partition 中的数据加载到内存。"}},"tags":["Partition 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 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"]},"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 将导致错误。"}}},"partitionNames":{"type":"array","items":{"type":"string","description":"A partition name.","x-i18n":{"zh-CN":{"description":"Partition 名称。"}}},"description":"The list of names of the target partitions.","x-i18n":{"zh-CN":{"description":"目标 Partition 名称列表。"}}}},"required":["partitionNames","collectionName"]},"example":{"collectionName":"medium_articles","partitionNames":["partition_1","partition_2"]}}}},"responses":{"200":{"description":"Return an empty object or an error message.","content":{"application/json":{"schema":{"anyOf":[{"x-tab-label":"success","description":"A success response","x-i18n":{"zh-CN":{"description":"成功响应"}},"x-i18n-langs":["zh-CN"],"type":"object","properties":{"code":{"description":"Response code.","x-i18n":{"zh-CN":{"description":"响应码。"}},"type":"integer","example":0},"data":{"type":"object","properties":{},"description":"Response payload which is an empty object.","x-i18n":{"zh-CN":{"description":"响应载荷。为空对象。"}}}}},{"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":{}}},"2":{"summary":"failure","x-target-response":"OPTION 2","value":{"code":0,"message":"The token is illegal."}}}}}}},"security":[]} export const endpoint = "/v2/vectordb/partitions/load" export const method = "post" diff --git a/API_Reference_MDX/milvus-restful/v2.4.x/v2/Vector (v2)/Delete.mdx b/API_Reference_MDX/milvus-restful/v2.4.x/v2/Vector (v2)/Delete.mdx index 818f7cf91..3694a00fc 100644 --- a/API_Reference_MDX/milvus-restful/v2.4.x/v2/Vector (v2)/Delete.mdx +++ b/API_Reference_MDX/milvus-restful/v2.4.x/v2/Vector (v2)/Delete.mdx @@ -15,6 +15,6 @@ import RestSpecs from '@site/src/components/RestSpecs'; -export const specs = {"summary":"Delete","deprecated":false,"description":"This operation deletes entities by their IDs or with a boolean expression.","x-i18n":{"zh-CN":{"summary":"删除","description":"根据 ID 或布尔表达式删除 Entity。"}},"tags":["Vector 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.","x-i18n":{"zh-CN":{"description":"目标数据库名称。"}},"x-include-target":["milvus"]},"collectionName":{"type":"string","description":"The name of an existing collection.","x-i18n":{"zh-CN":{"description":"现有 Collection 名称。"}}},"filter":{"type":"string","description":"A scalar filtering condition to filter matching entities. You can set this parameter to an empty string to skip scalar filtering. To build a scalar filtering condition, refer to [Boolean Expression Rules](https://milvus.io/docs/boolean.md)[Reference on Scalar Filters](/docs/get-and-scalar-query#reference-on-scalar-filters). ","x-i18n":{"zh-CN":{"description":"标量过滤条件,用于过滤匹配的 Entity。要构建标量过滤条件,请参考[布尔表达式规则](https://milvus.io/docs/boolean.md)[标量过滤器参考](/docs/get-and-scalar-query#reference-on-scalar-filters)。"}}},"partitionName":{"type":"string","description":"The name of a partition in the current collection. \nIf specified, the data is to be deleted from the specified partition.","x-i18n":{"zh-CN":{"description":"当前 Collection 中的 Partition 名称。\n如果指定,则从指定的 Partition 中删除数据。"}},"x-include-target":["milvus"]}},"required":["collectionName","filter"]},"examples":{"1":{"summary":"Option 1","value":{"collectionName":"medium_articles","filter":"id == 4321034832910"}},"2":{"summary":"Option 2","value":{"collectionName":"medium_articles","filter":"reading_time > 15"}}}}}},"responses":{"200":{"description":"Returns an empty object.","x-i18n":{"zh-CN":{"description":"返回空对象。"}},"content":{"application/json":{"schema":{"oneOf":[{"x-tab-label":"success","type":"object","properties":{"code":{"type":"integer","description":"Response code.","x-i18n":{"zh-CN":{"description":"响应码。"}}},"cost":{"type":"integer","description":"Cost of this operation.","x-i18n":{"zh-CN":{"description":"当前操作的花费。"}}},"data":{"type":"object","description":"Response payload which is an empty object.","x-i18n":{"zh-CN":{"description":"响应载荷,为空对象。"}},"properties":{}}}},{"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,"cost":0,"data":{}}},"2":{"summary":"failure","x-target-response":"OPTION 2","value":{"code":0,"message":"The token is illegal."}}}}}}},"security":[]} +export const specs = {"summary":"Delete","deprecated":false,"description":"This operation deletes entities by their IDs or with a boolean expression.","x-i18n":{"zh-CN":{"summary":"删除 Entity","description":"根据 ID 或布尔表达式删除 Entity。"}},"tags":["Vector 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.","x-i18n":{"zh-CN":{"description":"目标数据库名称。"}},"x-include-target":["milvus"]},"collectionName":{"type":"string","description":"The name of an existing collection.","x-i18n":{"zh-CN":{"description":"现有 Collection 名称。"}}},"filter":{"type":"string","description":"A scalar filtering condition to filter matching entities. You can set this parameter to an empty string to skip scalar filtering. To build a scalar filtering condition, refer to [Boolean Expression Rules](https://milvus.io/docs/boolean.md)[Reference on Scalar Filters](/docs/get-and-scalar-query#reference-on-scalar-filters). ","x-i18n":{"zh-CN":{"description":"标量过滤条件,用于过滤匹配的 Entity。要构建标量过滤条件,请参考[布尔表达式规则](https://milvus.io/docs/boolean.md)[标量过滤器参考](/docs/get-and-scalar-query#reference-on-scalar-filters)。"}}},"partitionName":{"type":"string","description":"The name of a partition in the current collection. \nIf specified, the data is to be deleted from the specified partition.","x-i18n":{"zh-CN":{"description":"当前 Collection 中的 Partition 名称。\n如果指定,则从指定的 Partition 中删除数据。"}},"x-include-target":["milvus"]}},"required":["collectionName","filter"]},"examples":{"1":{"summary":"Option 1","value":{"collectionName":"medium_articles","filter":"id == 4321034832910"}},"2":{"summary":"Option 2","value":{"collectionName":"medium_articles","filter":"reading_time > 15"}}}}}},"responses":{"200":{"description":"Returns an empty object.","x-i18n":{"zh-CN":{"description":"返回空对象。"}},"content":{"application/json":{"schema":{"oneOf":[{"x-tab-label":"success","type":"object","properties":{"code":{"type":"integer","description":"Response code.","x-i18n":{"zh-CN":{"description":"响应码。"}}},"cost":{"type":"integer","description":"Cost of this operation.","x-i18n":{"zh-CN":{"description":"当前操作的花费。"}}},"data":{"type":"object","description":"Response payload which is an empty object.","x-i18n":{"zh-CN":{"description":"响应载荷,为空对象。"}},"properties":{}}}},{"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,"cost":0,"data":{}}},"2":{"summary":"failure","x-target-response":"OPTION 2","value":{"code":0,"message":"The token is illegal."}}}}}}},"security":[]} export const endpoint = "/v2/vectordb/entities/delete" export const method = "post" diff --git a/API_Reference_MDX/milvus-restful/v2.4.x/v2/Vector (v2)/Hybrid Search.mdx b/API_Reference_MDX/milvus-restful/v2.4.x/v2/Vector (v2)/Hybrid Search.mdx index 3e02000fe..9dfe67ceb 100644 --- a/API_Reference_MDX/milvus-restful/v2.4.x/v2/Vector (v2)/Hybrid Search.mdx +++ b/API_Reference_MDX/milvus-restful/v2.4.x/v2/Vector (v2)/Hybrid Search.mdx @@ -15,6 +15,6 @@ import RestSpecs from '@site/src/components/RestSpecs'; -export const specs = {"summary":"Hybrid Search","deprecated":false,"description":"This operation searches for entities based on vector similarity and scalar filtering and reranks the results using a specified strategy.","x-i18n":{"zh-CN":{"summary":"混合搜索","description":"本接口基于向量相似度和标量过滤条件,搜索实体并使用指定策略重新排序结果。"}},"tags":["Vector 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 database.","x-i18n":{"zh-CN":{"description":"数据库名称。"}},"x-include-target":["milvus"]},"collectionName":{"type":"string","description":"The name of the collection to which this operation applies.","x-i18n":{"zh-CN":{"description":"Collection 名称。"}}},"partitionNames":{"type":"array","items":{"type":"string","description":"A partition name.","x-i18n":{"zh-CN":{"description":"一个 Partition 名称。"}}},"description":"The name of the partitions to which this operation applies. Setting this parameter indicates that the search is within the specified partitions. Otherwise, the search is across all partitions in the collection.","x-i18n":{"zh-CN":{"description":"Partition 名称列表。设置此参数表示搜索仅限于指定的 Partition。否则,搜索会在 Collection 中搜索所有 Partition。"}}},"search":{"type":"array","items":{"description":"Search parameter for a vector field.","x-i18n":{"zh-CN":{"description":"当前向量字段的检索参数。"}},"type":"object","properties":{"data":{"type":"array","items":{"type":"number","description":"A vector embedding","x-i18n":{"zh-CN":{"description":"一个向量嵌入。"}},"format":"float32"},"description":"A list of vector embeddings.MilvusZilliz Cloud searches for the most similar vector embeddings to the specified ones.","x-i18n":{"zh-CN":{"description":"一个向量嵌入列表。MilvusZilliz Cloud 会搜索与指定向量嵌入最相似的向量。"}}},"annsField":{"type":"string","description":"The name of the vector field.","x-i18n":{"zh-CN":{"description":"向量字段名称。"}}},"filter":{"type":"string","description":"A boolean expression filter.","x-i18n":{"zh-CN":{"description":"标量过滤条件。"}}},"groupingField":{"type":"string","description":"The name of the field that serve as the aggregation criteria.","x-i18n":{"zh-CN":{"description":"用于分组聚合的字段名称。"}}},"metricType":{"type":"string","description":"The name of the metric type that applies to the current search. The value should be the same as the metric type of the target collection.","x-i18n":{"zh-CN":{"description":"当前搜索所使用的度量类型。该值应与目标 Collection 的度量类型相同。"}},"enum":["L2","IP","COSINE"],"default":"COSINE"},"limit":{"type":"integer","description":"The number of entities to return.","x-i18n":{"zh-CN":{"description":"需要返回的 Entity 数量。"}}},"offset":{"type":"integer","description":"The number of entities to skip in the returned entities.","x-i18n":{"zh-CN":{"description":"需要在搜索结果中跳过的 Entity 数量。"}}},"ignoreGrowing":{"type":"boolean","description":"Whether to ignore the entities found in the growing segments.","x-i18n":{"zh-CN":{"description":"搜索时是否需要忽略 Growing Segment 中的 Entity。"}}},"params":{"description":"Extra search parameters.","type":"object","properties":{"radius":{"type":"integer","description":"Determines the threshold of least similarity. When setting metric_type to L2, ensure that this value is greater than that of range_filter. Otherwise, this value should be lower than that of range_filter. ","x-i18n":{"zh-CN":{"description":"确定最不相似向量的阈值。当设置 metric_type 为 L2 时,请确保该值大于 range_filter 的值。否则,该值应小于 range_filter 的值。"}}},"range_filter":{"type":"integer","description":"Refines the search to vectors within a specific similarity range. When setting metric_type to IP or COSINE, ensure that this value is greater than that of radius. Otherwise, this value should be lower than that of radius. ","x-i18n":{"zh-CN":{"description":"优化搜索结果的相似度范围。当设置 metric_type 为 IP 或 COSINE 时,请确保该值大于 radius 的值。否则,该值应小于 radius 的值。"}}}}}},"required":["data","annsField","filter","groupingField","limit","offset","ignoreGrowing"]},"description":"The search parameters","x-i18n":{"zh-CN":{"description":"搜索参数。"}}},"rerank":{"type":"object","properties":{"strategy":{"type":"string","description":"The name of the reranking strategy.","x-i18n":{"zh-CN":{"description":"重新排序策略。"}},"enum":["rrf","ws"]},"params":{"type":"object","properties":{"k":{"type":"integer","description":"A tunable constant in the RRF algorithm. This applies only when the strategy is set to `rrf`.","x-i18n":{"zh-CN":{"description":"可调节常数。仅当策略设置为 `rrf` 时适用。"}}}},"description":"A set of parameters related to the specified strategy","x-i18n":{"zh-CN":{"description":"指定重新排序策略的参数。"}},"required":["k"]}},"description":"The reranking strategy.","x-i18n":{"zh-CN":{"description":"重新排序策略。"}},"required":["params"]},"limit":{"type":"integer","description":"The total number of entities to return.\nYou can use this parameter in combination with **offset** in **param** to enable pagination.\nThe sum of this value and **offset** in **param** should be less than 16,384. ","x-i18n":{"zh-CN":{"description":"需要返回的 Entity 总数。\n您可以使用此参数与 **param** 中的 **offset** 结合使用,实现分页。\n此值与 **param** 中的 **offset** 之和应小于 16,384。"}}},"outputFields":{"type":"array","items":{"type":"string","description":"A field name","x-i18n":{"zh-CN":{"description":"字段名称"}}},"description":"An array of fields to return along with the search results.","x-i18n":{"zh-CN":{"description":"搜索结果中需要包含的字段列表。"}}}},"required":["collectionName","search"]},"example":{"collectionName":"test_collection","search":[{"data":[[0.673437956701697,0.739243747672878]],"annsField":"float_vector_1","limit":10,"outputFields":["*"]},{"data":[[0.075384179256879,0.9971545645073111]],"annsField":"float_vector_2","limit":10,"outputFields":["*"]}],"rerank":{"strategy":"rrf","params":{"k":10}},"limit":3,"outputFields":["user_id","word_count","book_describe"]}}}},"responses":{"200":{"description":"Returns the search results.","x-i18n":{"zh-CN":{"description":"返回搜索结果。"}},"content":{"application/json":{"schema":{"anyOf":[{"x-tab-label":"success","type":"object","properties":{"code":{"type":"integer","description":"Response code.","x-i18n":{"zh-CN":{"description":"响应码。"}}},"data":{"type":"array","description":"Search results","x-i18n":{"zh-CN":{"description":"搜索结果。"}},"items":{"type":"object","description":"An entity object.","x-i18n":{"zh-CN":{"descripiton":"一个返回的 Entity 对象。"}},"properties":{}}}}},{"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,"cost":0,"data":[{"book_describe":"book_105","distance":0.09090909,"id":450519760774180800,"user_id":5,"word_count":105},{"book_describe":"book_246","distance":0.09090909,"id":450519760774180900,"user_id":46,"word_count":246},{"book_describe":"book_367","distance":0.08333333600000001,"id":450519760774181060,"user_id":67,"word_count":367}]}},"2":{"summary":"failure","x-target-response":"OPTION 2","value":{"code":0,"message":"The token is illegal."}}}}}}},"security":[]} +export const specs = {"summary":"Hybrid Search","deprecated":false,"description":"This operation searches for entities based on vector similarity and scalar filtering and reranks the results using a specified strategy.","x-i18n":{"zh-CN":{"summary":"Hybrid Search","description":"本接口基于向量相似度和标量过滤条件,搜索实体并使用指定策略重新排序结果。"}},"tags":["Vector 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 database.","x-i18n":{"zh-CN":{"description":"数据库名称。"}},"x-include-target":["milvus"]},"collectionName":{"type":"string","description":"The name of the collection to which this operation applies.","x-i18n":{"zh-CN":{"description":"Collection 名称。"}}},"partitionNames":{"type":"array","items":{"type":"string","description":"A partition name.","x-i18n":{"zh-CN":{"description":"一个 Partition 名称。"}}},"description":"The name of the partitions to which this operation applies. Setting this parameter indicates that the search is within the specified partitions. Otherwise, the search is across all partitions in the collection.","x-i18n":{"zh-CN":{"description":"Partition 名称列表。设置此参数表示搜索仅限于指定的 Partition。否则,搜索会在 Collection 中搜索所有 Partition。"}}},"search":{"type":"array","items":{"description":"Search parameter for a vector field.","x-i18n":{"zh-CN":{"description":"当前向量字段的检索参数。"}},"type":"object","properties":{"data":{"type":"array","items":{"type":"number","description":"A vector embedding","x-i18n":{"zh-CN":{"description":"一个向量嵌入。"}},"format":"float32"},"description":"A list of vector embeddings.MilvusZilliz Cloud searches for the most similar vector embeddings to the specified ones.","x-i18n":{"zh-CN":{"description":"一个向量嵌入列表。MilvusZilliz Cloud 会搜索与指定向量嵌入最相似的向量。"}}},"annsField":{"type":"string","description":"The name of the vector field.","x-i18n":{"zh-CN":{"description":"向量字段名称。"}}},"filter":{"type":"string","description":"A boolean expression filter.","x-i18n":{"zh-CN":{"description":"标量过滤条件。"}}},"groupingField":{"type":"string","description":"The name of the field that serve as the aggregation criteria.","x-i18n":{"zh-CN":{"description":"用于分组聚合的字段名称。"}}},"metricType":{"type":"string","description":"The name of the metric type that applies to the current search. The value should be the same as the metric type of the target collection.","x-i18n":{"zh-CN":{"description":"当前搜索所使用的度量类型。该值应与目标 Collection 的度量类型相同。"}},"enum":["L2","IP","COSINE"],"default":"COSINE"},"limit":{"type":"integer","description":"The number of entities to return.","x-i18n":{"zh-CN":{"description":"需要返回的 Entity 数量。"}}},"offset":{"type":"integer","description":"The number of entities to skip in the returned entities.","x-i18n":{"zh-CN":{"description":"需要在搜索结果中跳过的 Entity 数量。"}}},"ignoreGrowing":{"type":"boolean","description":"Whether to ignore the entities found in the growing segments.","x-i18n":{"zh-CN":{"description":"搜索时是否需要忽略 Growing Segment 中的 Entity。"}}},"params":{"description":"Extra search parameters.","type":"object","properties":{"radius":{"type":"integer","description":"Determines the threshold of least similarity. When setting metric_type to L2, ensure that this value is greater than that of range_filter. Otherwise, this value should be lower than that of range_filter. ","x-i18n":{"zh-CN":{"description":"确定最不相似向量的阈值。当设置 metric_type 为 L2 时,请确保该值大于 range_filter 的值。否则,该值应小于 range_filter 的值。"}}},"range_filter":{"type":"integer","description":"Refines the search to vectors within a specific similarity range. When setting metric_type to IP or COSINE, ensure that this value is greater than that of radius. Otherwise, this value should be lower than that of radius. ","x-i18n":{"zh-CN":{"description":"优化搜索结果的相似度范围。当设置 metric_type 为 IP 或 COSINE 时,请确保该值大于 radius 的值。否则,该值应小于 radius 的值。"}}}}}},"required":["data","annsField","filter","groupingField","limit","offset","ignoreGrowing"]},"description":"The search parameters","x-i18n":{"zh-CN":{"description":"搜索参数。"}}},"rerank":{"type":"object","properties":{"strategy":{"type":"string","description":"The name of the reranking strategy.","x-i18n":{"zh-CN":{"description":"重新排序策略。"}},"enum":["rrf","weighted"]},"params":{"type":"object","properties":{"k":{"type":"integer","description":"A tunable constant in the RRF algorithm. This applies only when the strategy is set to `rrf`.","x-i18n":{"zh-CN":{"description":"可调节常数。仅当策略设置为 `rrf` 时适用。"}}}},"description":"A set of parameters related to the specified strategy","x-i18n":{"zh-CN":{"description":"指定重新排序策略的参数。"}},"required":["k"]}},"description":"The reranking strategy.","x-i18n":{"zh-CN":{"description":"重新排序策略。"}},"required":["params"]},"limit":{"type":"integer","description":"The total number of entities to return.\nYou can use this parameter in combination with **offset** in **param** to enable pagination.\nThe sum of this value and **offset** in **param** should be less than 16,384. ","x-i18n":{"zh-CN":{"description":"需要返回的 Entity 总数。\n您可以使用此参数与 **param** 中的 **offset** 结合使用,实现分页。\n此值与 **param** 中的 **offset** 之和应小于 16,384。"}}},"outputFields":{"type":"array","items":{"type":"string","description":"A field name","x-i18n":{"zh-CN":{"description":"字段名称"}}},"description":"An array of fields to return along with the search results.","x-i18n":{"zh-CN":{"description":"搜索结果中需要包含的字段列表。"}}}},"required":["collectionName","search"]},"example":{"collectionName":"test_collection","search":[{"data":[[0.673437956701697,0.739243747672878]],"annsField":"float_vector_1","limit":10,"outputFields":["*"]},{"data":[[0.075384179256879,0.9971545645073111]],"annsField":"float_vector_2","limit":10,"outputFields":["*"]}],"rerank":{"strategy":"rrf","params":{"k":10}},"limit":3,"outputFields":["user_id","word_count","book_describe"]}}}},"responses":{"200":{"description":"Returns the search results.","x-i18n":{"zh-CN":{"description":"返回搜索结果。"}},"content":{"application/json":{"schema":{"anyOf":[{"x-tab-label":"success","type":"object","properties":{"code":{"type":"integer","description":"Response code.","x-i18n":{"zh-CN":{"description":"响应码。"}}},"data":{"type":"array","description":"Search results","x-i18n":{"zh-CN":{"description":"搜索结果。"}},"items":{"type":"object","description":"An entity object.","x-i18n":{"zh-CN":{"descripiton":"一个返回的 Entity 对象。"}},"properties":{}}}}},{"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,"cost":0,"data":[{"book_describe":"book_105","distance":0.09090909,"id":450519760774180800,"user_id":5,"word_count":105},{"book_describe":"book_246","distance":0.09090909,"id":450519760774180900,"user_id":46,"word_count":246},{"book_describe":"book_367","distance":0.08333333600000001,"id":450519760774181060,"user_id":67,"word_count":367}]}},"2":{"summary":"failure","x-target-response":"OPTION 2","value":{"code":0,"message":"The token is illegal."}}}}}}},"security":[]} export const endpoint = "/v2/vectordb/entities/hybrid_search" export const method = "post" diff --git a/API_Reference_MDX/milvus-restful/v2.4.x/v2/Vector (v2)/Insert.mdx b/API_Reference_MDX/milvus-restful/v2.4.x/v2/Vector (v2)/Insert.mdx index 1de7eb3c6..748b67e5a 100644 --- a/API_Reference_MDX/milvus-restful/v2.4.x/v2/Vector (v2)/Insert.mdx +++ b/API_Reference_MDX/milvus-restful/v2.4.x/v2/Vector (v2)/Insert.mdx @@ -15,6 +15,6 @@ import RestSpecs from '@site/src/components/RestSpecs'; -export const specs = {"summary":"Insert","deprecated":false,"description":"This operation inserts data into a specific collection. ","x-i18n":{"zh-CN":{"summary":"插入数据","description":"本接口向指定 Collection 中插入数据。"}},"tags":["Vector 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.","x-i18n":{"zh-CN":{"description":"目标数据库名称。"}},"x-include-target":["milvus"]},"collectionName":{"type":"string","description":"The name of an existing collection.","x-i18n":{"zh-CN":{"description":"已存在的 Collection 名称。"}}},"data":{"description":"An entity object or an array of entity objects. Note that the keys in an entity object should match the collection schema","x-i18n":{"zh-CN":{"description":"Entity 对象或 Entity 对象数组。注意,Entity 对象的结构应与 Collection Schema 一致。"}},"oneOf":[{"type":"object","description":"A single entity, whose structure should match the schema of the target collection.","x-i18n":{"zh-CN":{"description":"单个 Entity 对象,其结构应与目标 Collection 的 Schema 一致。"}},"properties":{}},{"type":"array","description":"A list of entities, each of which should match the schema of the target collection.","x-i18n":{"zh-CN":{"description":"Entity 对象列表,每个对象应与目标 Collection 的 Schema 一致。"}},"items":{"type":"object","description":"An entity object, whose structure should match the schema of the target collection.","x-i18n":{"zh-CN":{"description":"一个 Entity 对象,其结构应与目标 Collection 的 Schema 一致。"}},"properties":{}}}]},"partitionName":{"type":"string","description":"The name of a partition in the current collection. \nIf specified, the data is to be inserted into the specified partition.","x-i18n":{"zh-CN":{"description":"当前 Collection 中的 Partition 名称。\n如果指定,则将数据插入指定的 Partition。"}}}},"required":["data","collectionName"]},"examples":{"1":{"summary":"example","value":{"data":[{"id":0,"vector":[0.3580376395471989,-0.6023495712049978,0.18414012509913835,-0.26286205330961354,0.9029438446296592],"color":"pink_8682"},{"id":1,"vector":[0.19886812562848388,0.06023560599112088,0.6976963061752597,0.2614474506242501,0.838729485096104],"color":"red_7025"},{"id":2,"vector":[0.43742130801983836,-0.5597502546264526,0.6457887650909682,0.7894058910881185,0.20785793220625592],"color":"orange_6781"},{"id":3,"vector":[0.3172005263489739,0.9719044792798428,-0.36981146090600725,-0.4860894583077995,0.95791889146345],"color":"pink_9298"},{"id":4,"vector":[0.4452349528804562,-0.8757026943054742,0.8220779437047674,0.46406290649483184,0.30337481143159106],"color":"red_4794"},{"id":5,"vector":[0.985825131989184,-0.8144651566660419,0.6299267002202009,0.1206906911183383,-0.1446277761879955],"color":"yellow_4222"},{"id":6,"vector":[0.8371977790571115,-0.015764369584852833,-0.31062937026679327,-0.562666951622192,-0.8984947637863987],"color":"red_9392"},{"id":7,"vector":[-0.33445148015177995,-0.2567135004164067,0.8987539745369246,0.9402995886420709,0.5378064918413052],"color":"grey_8510"},{"id":8,"vector":[0.39524717779832685,0.4000257286739164,-0.5890507376891594,-0.8650502298996872,-0.6140360785406336],"color":"white_9381"},{"id":9,"vector":[0.5718280481994695,0.24070317428066512,-0.3737913482606834,-0.06726932177492717,-0.6980531615588608],"color":"purple_4976"}],"collectionName":"quick_setup"}}}}}},"responses":{"200":{"description":"A dictionary contains information about the number of inserted entities.","x-i18n":{"zh-CN":{"description":"返回一个包含成功插入 Entity 条数相关信息的字典。"}},"content":{"application/json":{"schema":{"anyOf":[{"x-tab-label":"success","type":"object","properties":{"code":{"type":"integer","description":"Response code.","x-i18n":{"zh-CN":{"description":"响应码。"}}},"data":{"type":"object","description":"Response payload which carries the results of this operation.","x-i18n":{"zh-CN":{"description":"响应负载,包含了当前操作的结果。"}},"properties":{"insertCount":{"type":"integer","example":4,"description":"The number of inserted entities.","x-i18n":{"zh-CN":{"description":"已插入 Entity 数量。"}}},"insertIds":{"type":"array","items":{"type":"string","description":"The ID of an inserted entity.","x-i18n":{"zh-CN":{"description":"一个已插入的 Entity 的 ID。"}}},"description":"An array of the IDs of inserted entities.","x-i18n":{"zh-CN":{"description":"已插入 Entity 的 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":{"insertCount":10,"insertIds":[0,1,2,3,4,5,6,7,8,9]}}},"2":{"summary":"failure","x-target-response":"OPTION 2","value":{"code":0,"message":"The token is illegal."}}}}}}},"security":[]} +export const specs = {"summary":"Insert","deprecated":false,"description":"This operation inserts data into a specific collection. ","x-i18n":{"zh-CN":{"summary":"插入 Entity","description":"本接口向指定 Collection 中插入 Entity。"}},"tags":["Vector 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.","x-i18n":{"zh-CN":{"description":"目标数据库名称。"}},"x-include-target":["milvus"]},"collectionName":{"type":"string","description":"The name of an existing collection.","x-i18n":{"zh-CN":{"description":"已存在的 Collection 名称。"}}},"data":{"description":"An entity object or an array of entity objects. Note that the keys in an entity object should match the collection schema","x-i18n":{"zh-CN":{"description":"Entity 对象或 Entity 对象数组。注意,Entity 对象的结构应与 Collection Schema 一致。"}},"oneOf":[{"type":"object","description":"A single entity, whose structure should match the schema of the target collection.","x-i18n":{"zh-CN":{"description":"单个 Entity 对象,其结构应与目标 Collection 的 Schema 一致。"}},"properties":{}},{"type":"array","description":"A list of entities, each of which should match the schema of the target collection.","x-i18n":{"zh-CN":{"description":"Entity 对象列表,每个对象应与目标 Collection 的 Schema 一致。"}},"items":{"type":"object","description":"An entity object, whose structure should match the schema of the target collection.","x-i18n":{"zh-CN":{"description":"一个 Entity 对象,其结构应与目标 Collection 的 Schema 一致。"}},"properties":{}}}]},"partitionName":{"type":"string","description":"The name of a partition in the current collection. \nIf specified, the data is to be inserted into the specified partition.","x-i18n":{"zh-CN":{"description":"当前 Collection 中的 Partition 名称。\n如果指定,则将数据插入指定的 Partition。"}}}},"required":["data","collectionName"]},"examples":{"1":{"summary":"example","value":{"data":[{"id":0,"vector":[0.3580376395471989,-0.6023495712049978,0.18414012509913835,-0.26286205330961354,0.9029438446296592],"color":"pink_8682"},{"id":1,"vector":[0.19886812562848388,0.06023560599112088,0.6976963061752597,0.2614474506242501,0.838729485096104],"color":"red_7025"},{"id":2,"vector":[0.43742130801983836,-0.5597502546264526,0.6457887650909682,0.7894058910881185,0.20785793220625592],"color":"orange_6781"},{"id":3,"vector":[0.3172005263489739,0.9719044792798428,-0.36981146090600725,-0.4860894583077995,0.95791889146345],"color":"pink_9298"},{"id":4,"vector":[0.4452349528804562,-0.8757026943054742,0.8220779437047674,0.46406290649483184,0.30337481143159106],"color":"red_4794"},{"id":5,"vector":[0.985825131989184,-0.8144651566660419,0.6299267002202009,0.1206906911183383,-0.1446277761879955],"color":"yellow_4222"},{"id":6,"vector":[0.8371977790571115,-0.015764369584852833,-0.31062937026679327,-0.562666951622192,-0.8984947637863987],"color":"red_9392"},{"id":7,"vector":[-0.33445148015177995,-0.2567135004164067,0.8987539745369246,0.9402995886420709,0.5378064918413052],"color":"grey_8510"},{"id":8,"vector":[0.39524717779832685,0.4000257286739164,-0.5890507376891594,-0.8650502298996872,-0.6140360785406336],"color":"white_9381"},{"id":9,"vector":[0.5718280481994695,0.24070317428066512,-0.3737913482606834,-0.06726932177492717,-0.6980531615588608],"color":"purple_4976"}],"collectionName":"quick_setup"}}}}}},"responses":{"200":{"description":"A dictionary contains information about the number of inserted entities.","x-i18n":{"zh-CN":{"description":"返回一个包含成功插入 Entity 条数相关信息的字典。"}},"content":{"application/json":{"schema":{"anyOf":[{"x-tab-label":"success","type":"object","properties":{"code":{"type":"integer","description":"Response code.","x-i18n":{"zh-CN":{"description":"响应码。"}}},"data":{"type":"object","description":"Response payload which carries the results of this operation.","x-i18n":{"zh-CN":{"description":"响应负载,包含了当前操作的结果。"}},"properties":{"insertCount":{"type":"integer","example":4,"description":"The number of inserted entities.","x-i18n":{"zh-CN":{"description":"已插入 Entity 数量。"}}},"insertIds":{"type":"array","items":{"type":"string","description":"The ID of an inserted entity.","x-i18n":{"zh-CN":{"description":"一个已插入的 Entity 的 ID。"}}},"description":"An array of the IDs of inserted entities.","x-i18n":{"zh-CN":{"description":"已插入 Entity 的 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":{"insertCount":10,"insertIds":[0,1,2,3,4,5,6,7,8,9]}}},"2":{"summary":"failure","x-target-response":"OPTION 2","value":{"code":0,"message":"The token is illegal."}}}}}}},"security":[]} export const endpoint = "/v2/vectordb/entities/insert" export const method = "post" diff --git a/API_Reference_MDX/milvus-restful/v2.4.x/v2/Vector (v2)/Upsert.mdx b/API_Reference_MDX/milvus-restful/v2.4.x/v2/Vector (v2)/Upsert.mdx index 3e0be8255..7885a39fd 100644 --- a/API_Reference_MDX/milvus-restful/v2.4.x/v2/Vector (v2)/Upsert.mdx +++ b/API_Reference_MDX/milvus-restful/v2.4.x/v2/Vector (v2)/Upsert.mdx @@ -15,6 +15,6 @@ import RestSpecs from '@site/src/components/RestSpecs'; -export const specs = {"summary":"Upsert","deprecated":false,"description":"This operation inserts new records into the database or updates existing ones.","x-i18n":{"zh-CN":{"summary":"插入或更新","description":"本接口用于向指定 Collection 中插入或更新数据。"}},"tags":["Vector 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 database.","x-i18n":{"zh-CN":{"description":"数据库名称。"}},"x-include-target":["milvus"]},"collectionName":{"type":"string","description":"The name of the collection in which to upsert data.","x-i18n":{"zh-CN":{"description":"待插入或更新记录的目标 Collection 名称。"}}},"partitionName":{"type":"string","description":"The name of a partition in the current collection. \nIf specified, the data is to be inserted into the specified partition."},"data":{"type":"object | array","description":"An entity object or an array of entity objects. Note that the keys in an entity object should match the collection schema","x-i18n":{"zh-CN":{"description":"Entity 对象或 Entity 对象数组。注意,Entity 对象的结构应与 Collection Schema 一致。"}}}},"required":["data","collectionName"]},"example":{"data":[{"id":0,"vector":[0.3580376395471989,-0.6023495712049978,0.18414012509913835,-0.26286205330961354,0.9029438446296592],"color":"pink_8682"},{"id":1,"vector":[0.19886812562848388,0.06023560599112088,0.6976963061752597,0.2614474506242501,0.838729485096104],"color":"red_7025"},{"id":2,"vector":[0.43742130801983836,-0.5597502546264526,0.6457887650909682,0.7894058910881185,0.20785793220625592],"color":"orange_6781"},{"id":3,"vector":[0.3172005263489739,0.9719044792798428,-0.36981146090600725,-0.4860894583077995,0.95791889146345],"color":"pink_9298"},{"id":4,"vector":[0.4452349528804562,-0.8757026943054742,0.8220779437047674,0.46406290649483184,0.30337481143159106],"color":"red_4794"},{"id":5,"vector":[0.985825131989184,-0.8144651566660419,0.6299267002202009,0.1206906911183383,-0.1446277761879955],"color":"yellow_4222"},{"id":6,"vector":[0.8371977790571115,-0.015764369584852833,-0.31062937026679327,-0.562666951622192,-0.8984947637863987],"color":"red_9392"},{"id":7,"vector":[-0.33445148015177995,-0.2567135004164067,0.8987539745369246,0.9402995886420709,0.5378064918413052],"color":"grey_8510"},{"id":8,"vector":[0.39524717779832685,0.4000257286739164,-0.5890507376891594,-0.8650502298996872,-0.6140360785406336],"color":"white_9381"},{"id":9,"vector":[0.5718280481994695,0.24070317428066512,-0.3737913482606834,-0.06726932177492717,-0.6980531615588608],"color":"purple_4976"}],"collectionName":"quick_setup"}}}},"responses":{"200":{"description":"A MutationResult object.","x-i18n":{"zh-CN":{"description":"返回一个 MutationResult 对象。"}},"content":{"application/json":{"schema":{"anyOf":[{"x-tab-label":"success","type":"object","properties":{"code":{"type":"integer","description":"Response code.","x-i18n":{"zh-CN":{"description":"响应码。"}}},"data":{"type":"object","description":"Response payload which carries the result of the upsert operation.","x-i18n":{"zh-CN":{"description":"响应载荷,包含了 upsert 操作的结果。"}},"properties":{"upsertCount":{"type":"integer","example":4,"description":"The number of upserted entities.","x-i18n":{"zh-CN":{"description":"插入或更新的 Entity 数量。"}}},"upsertIds":{"type":"array","items":{"type":"string","description":"The ID of an upserted entity.","x-i18n":{"zh-CN":{"description":"一个插入或更新的 Entity ID。"}}},"description":"An array of the IDs of upserted entities.","x-i18n":{"zh-CN":{"description":"插入或更新的 Entity 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":{"upsertCount":10,"upsertIds":[0,1,2,3,4,5,6,7,8,9]}}},"2":{"summary":"failure","x-target-response":"OPTION 2","value":{"code":0,"message":"The token is illegal."}}}}}}},"security":[]} +export const specs = {"summary":"Upsert","deprecated":false,"description":"This operation inserts new records into the database or updates existing ones.","x-i18n":{"zh-CN":{"summary":"Upsert","description":"本接口用于向指定 Collection 中插入或更新数据。"}},"tags":["Vector 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 database.","x-i18n":{"zh-CN":{"description":"数据库名称。"}},"x-include-target":["milvus"]},"collectionName":{"type":"string","description":"The name of the collection in which to upsert data.","x-i18n":{"zh-CN":{"description":"待插入或更新记录的目标 Collection 名称。"}}},"partitionName":{"type":"string","description":"The name of a partition in the current collection. \nIf specified, the data is to be inserted into the specified partition."},"data":{"type":"object | array","description":"An entity object or an array of entity objects. Note that the keys in an entity object should match the collection schema","x-i18n":{"zh-CN":{"description":"Entity 对象或 Entity 对象数组。注意,Entity 对象的结构应与 Collection Schema 一致。"}}}},"required":["data","collectionName"]},"example":{"data":[{"id":0,"vector":[0.3580376395471989,-0.6023495712049978,0.18414012509913835,-0.26286205330961354,0.9029438446296592],"color":"pink_8682"},{"id":1,"vector":[0.19886812562848388,0.06023560599112088,0.6976963061752597,0.2614474506242501,0.838729485096104],"color":"red_7025"},{"id":2,"vector":[0.43742130801983836,-0.5597502546264526,0.6457887650909682,0.7894058910881185,0.20785793220625592],"color":"orange_6781"},{"id":3,"vector":[0.3172005263489739,0.9719044792798428,-0.36981146090600725,-0.4860894583077995,0.95791889146345],"color":"pink_9298"},{"id":4,"vector":[0.4452349528804562,-0.8757026943054742,0.8220779437047674,0.46406290649483184,0.30337481143159106],"color":"red_4794"},{"id":5,"vector":[0.985825131989184,-0.8144651566660419,0.6299267002202009,0.1206906911183383,-0.1446277761879955],"color":"yellow_4222"},{"id":6,"vector":[0.8371977790571115,-0.015764369584852833,-0.31062937026679327,-0.562666951622192,-0.8984947637863987],"color":"red_9392"},{"id":7,"vector":[-0.33445148015177995,-0.2567135004164067,0.8987539745369246,0.9402995886420709,0.5378064918413052],"color":"grey_8510"},{"id":8,"vector":[0.39524717779832685,0.4000257286739164,-0.5890507376891594,-0.8650502298996872,-0.6140360785406336],"color":"white_9381"},{"id":9,"vector":[0.5718280481994695,0.24070317428066512,-0.3737913482606834,-0.06726932177492717,-0.6980531615588608],"color":"purple_4976"}],"collectionName":"quick_setup"}}}},"responses":{"200":{"description":"A MutationResult object.","x-i18n":{"zh-CN":{"description":"返回一个 MutationResult 对象。"}},"content":{"application/json":{"schema":{"anyOf":[{"x-tab-label":"success","type":"object","properties":{"code":{"type":"integer","description":"Response code.","x-i18n":{"zh-CN":{"description":"响应码。"}}},"data":{"type":"object","description":"Response payload which carries the result of the upsert operation.","x-i18n":{"zh-CN":{"description":"响应载荷,包含了 upsert 操作的结果。"}},"properties":{"upsertCount":{"type":"integer","example":4,"description":"The number of upserted entities.","x-i18n":{"zh-CN":{"description":"插入或更新的 Entity 数量。"}}},"upsertIds":{"type":"array","items":{"type":"string","description":"The ID of an upserted entity.","x-i18n":{"zh-CN":{"description":"一个插入或更新的 Entity ID。"}}},"description":"An array of the IDs of upserted entities.","x-i18n":{"zh-CN":{"description":"插入或更新的 Entity 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":{"upsertCount":10,"upsertIds":[0,1,2,3,4,5,6,7,8,9]}}},"2":{"summary":"failure","x-target-response":"OPTION 2","value":{"code":0,"message":"The token is illegal."}}}}}}},"security":[]} export const endpoint = "/v2/vectordb/entities/upsert" export const method = "post"