diff --git a/API_Reference_MDX/milvus-restful/v2.5.x/v2/Alias (v2)/Alter.mdx b/API_Reference_MDX/milvus-restful/v2.5.x/v2/Alias (v2)/Alter.mdx index 14b460a2e..371c293cc 100644 --- a/API_Reference_MDX/milvus-restful/v2.5.x/v2/Alias (v2)/Alter.mdx +++ b/API_Reference_MDX/milvus-restful/v2.5.x/v2/Alias (v2)/Alter.mdx @@ -1,12 +1,20 @@ --- displayed_sidebar: restfulSidebar -sidebar_positition: 49 +sidebar_positition: 59 slug: /restful/Alter title: "Alter Alias | RESTful" description: "This operation reassigns the alias of one collection to another. | RESTful" hide_table_of_contents: true sidebar_label: "Alter Alias" sidebar_custom_props: { badges: ['post']} +keywords: + - zilliz cloud + - zilliz + - cloud + - "Alter Alias" + - "post" + - RESTful + - API --- # Alter Alias @@ -15,6 +23,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":"修改 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 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":"数据库名称。"}}},"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":1800,"message":"User hasn't authenticated"}}}}}}},"security":[]} export const endpoint = "/v2/vectordb/aliases/alter" export const method = "post" diff --git a/API_Reference_MDX/milvus-restful/v2.5.x/v2/Alias (v2)/Create.mdx b/API_Reference_MDX/milvus-restful/v2.5.x/v2/Alias (v2)/Create.mdx index c23b389a0..5e8ca41b3 100644 --- a/API_Reference_MDX/milvus-restful/v2.5.x/v2/Alias (v2)/Create.mdx +++ b/API_Reference_MDX/milvus-restful/v2.5.x/v2/Alias (v2)/Create.mdx @@ -1,12 +1,20 @@ --- displayed_sidebar: restfulSidebar -sidebar_positition: 74 +sidebar_positition: 84 slug: /restful/Create title: "Create Alias | RESTful" 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. | RESTful" hide_table_of_contents: true sidebar_label: "Create Alias" sidebar_custom_props: { badges: ['post']} +keywords: + - zilliz cloud + - zilliz + - cloud + - "Create Alias" + - "post" + - RESTful + - API --- # Create Alias @@ -15,6 +23,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":"创建 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 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 所属的数据库名称。"}}},"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":1800,"message":"User hasn't authenticated"}}}}}}},"security":[]} export const endpoint = "/v2/vectordb/aliases/create" export const method = "post" diff --git a/API_Reference_MDX/milvus-restful/v2.5.x/v2/Alias (v2)/Describe.mdx b/API_Reference_MDX/milvus-restful/v2.5.x/v2/Alias (v2)/Describe.mdx index a189baf5a..e1c2b9f2b 100644 --- a/API_Reference_MDX/milvus-restful/v2.5.x/v2/Alias (v2)/Describe.mdx +++ b/API_Reference_MDX/milvus-restful/v2.5.x/v2/Alias (v2)/Describe.mdx @@ -1,12 +1,20 @@ --- displayed_sidebar: restfulSidebar -sidebar_positition: 37 +sidebar_positition: 47 slug: /restful/Describe title: "Describe Alias | RESTful" description: "This operation describes the details of a specific alias. | RESTful" hide_table_of_contents: true sidebar_label: "Describe Alias" sidebar_custom_props: { badges: ['post']} +keywords: + - zilliz cloud + - zilliz + - cloud + - "Describe Alias" + - "post" + - RESTful + - API --- # Describe Alias @@ -15,6 +23,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":"查看 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 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":"当前别名所属的数据库名称。"}}},"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 所属的数据库名称。"}}},"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":1800,"message":"User hasn't authenticated"}}}}}}},"security":[]} export const endpoint = "/v2/vectordb/aliases/describe" export const method = "post" diff --git a/API_Reference_MDX/milvus-restful/v2.5.x/v2/Alias (v2)/Drop.mdx b/API_Reference_MDX/milvus-restful/v2.5.x/v2/Alias (v2)/Drop.mdx index c1b519fc0..451fdf4bb 100644 --- a/API_Reference_MDX/milvus-restful/v2.5.x/v2/Alias (v2)/Drop.mdx +++ b/API_Reference_MDX/milvus-restful/v2.5.x/v2/Alias (v2)/Drop.mdx @@ -1,12 +1,20 @@ --- displayed_sidebar: restfulSidebar -sidebar_positition: 63 +sidebar_positition: 73 slug: /restful/Drop title: "Drop Alias | RESTful" description: "This operation drops a specified alias. | RESTful" hide_table_of_contents: true sidebar_label: "Drop Alias" sidebar_custom_props: { badges: ['post']} +keywords: + - zilliz cloud + - zilliz + - cloud + - "Drop Alias" + - "post" + - RESTful + - API --- # Drop Alias @@ -15,6 +23,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"]},"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 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":"数据库名称。"}}},"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":1800,"message":"User hasn't authenticated"}}}}}}},"security":[]} export const endpoint = "/v2/vectordb/aliases/drop" export const method = "post" diff --git a/API_Reference_MDX/milvus-restful/v2.5.x/v2/Alias (v2)/List.mdx b/API_Reference_MDX/milvus-restful/v2.5.x/v2/Alias (v2)/List.mdx index 8d14d0561..f9f339f49 100644 --- a/API_Reference_MDX/milvus-restful/v2.5.x/v2/Alias (v2)/List.mdx +++ b/API_Reference_MDX/milvus-restful/v2.5.x/v2/Alias (v2)/List.mdx @@ -1,12 +1,20 @@ --- displayed_sidebar: restfulSidebar -sidebar_positition: 25 +sidebar_positition: 31 slug: /restful/List title: "List Aliases | RESTful" description: "This operation lists all existing collection aliases in the specified database. | RESTful" hide_table_of_contents: true sidebar_label: "List Aliases" sidebar_custom_props: { badges: ['post']} +keywords: + - zilliz cloud + - zilliz + - cloud + - "List Aliases" + - "post" + - RESTful + - API --- # List Aliases @@ -15,6 +23,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":"查看 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 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":"已存在的数据库名称。"}}},"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。"}}}}},"example":{"value":{"dbName":"default"}}}}},"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":1800,"message":"User hasn't authenticated"}}}}}}},"security":[]} export const endpoint = "/v2/vectordb/aliases/list" export const method = "post" diff --git a/API_Reference_MDX/milvus-restful/v2.5.x/v2/Collection (v2)/Alter Properties.mdx b/API_Reference_MDX/milvus-restful/v2.5.x/v2/Collection (v2)/Alter Properties.mdx new file mode 100644 index 000000000..31f25418e --- /dev/null +++ b/API_Reference_MDX/milvus-restful/v2.5.x/v2/Collection (v2)/Alter Properties.mdx @@ -0,0 +1,28 @@ +--- +displayed_sidebar: restfulSidebar +sidebar_positition: 96 +slug: /restful/Alter Properties +title: "Alter Collection Properties | RESTful" +description: "This operation alters the properties of a collection. | RESTful" +hide_table_of_contents: true +sidebar_label: "Alter Collection Properties" +sidebar_custom_props: { badges: ['post']} +keywords: + - zilliz cloud + - zilliz + - cloud + - "Alter Collection Properties" + - "post" + - RESTful + - API +--- + +# Alter Collection Properties + +import RestSpecs from '@site/src/components/RestSpecs'; + + + +export const specs = {"summary":"Alter Collection Properties","deprecated":false,"description":"This operation alters the properties of a 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 the database which the collection belongs to. Setting this to a non-existing database results in an error.","x-i18n":{"zh-CN":{"description":"Database 名称。"}}},"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 名称。"}}},"properties":{"type":"object","description":"The properties of the collection to alter.","x-i18n":{"zh-CN":{"description":"待修改 Collection 属性。"}},"properties":{"mmmap.enabled":{"type":"boolean","description":"Whether to enable the memory-mapped feature for the collection. Setting this to `true` allows the collection to be accessed directly from disk without loading it into memory, which can extend collection capacity.","x-i18n":{"zh-CN":{"description":"是否启用内存映射特性。将该属性设置为 `true` 允许直接从磁盘访问 Collection，而无需将其加载到内存，从而扩大 Collection 容量。"}}},"collection.ttl.seconds":{"type":"integer","description":"The time-to-live (TTL) of the collection in seconds. Setting this to a non-zero values enables automatic deletion of expired documents from the collection after the specified number of seconds.","x-i18n":{"zh-CN":{"description":"Collection 的 TTL（秒）。将该属性设置为非零值将在指定秒数后自动删除过期文档。"}}},"partitionkey.isolation":{"type":"boolean","description":"Whether to enable partition key isolation for the collection. Setting this to `true` ensures that documents with the same partition key are always stored in the same partition, which can improve query performance.","x-i18n":{"zh-CN":{"description":"是否启用分区键隔离特性。将该属性设置为 `true` 确保具有相同分区键的文档始终存储在相同的分区中，从而提高查询性能。"}}}}}},"required":["collectionName","properties"]},"example":{"collectionName":"test_collection","properties":{"mmmap.enabled":true}}}}},"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":"响应码。"}}},"data":{"type":"object","properties":{}}}},{"x-tab-label":"failure","description":"Returns an error message.","x-i18n":{"zh-CN":{"description":"返回错误消息。"}},"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":1800,"message":"User hasn't authenticated"}}}}}}}} +export const endpoint = "/v2/vectordb/collections/alter_properties" +export const method = "post" diff --git a/API_Reference_MDX/milvus-restful/v2.5.x/v2/Collection (v2)/Compact.mdx b/API_Reference_MDX/milvus-restful/v2.5.x/v2/Collection (v2)/Compact.mdx new file mode 100644 index 000000000..7a1313825 --- /dev/null +++ b/API_Reference_MDX/milvus-restful/v2.5.x/v2/Collection (v2)/Compact.mdx @@ -0,0 +1,28 @@ +--- +displayed_sidebar: restfulSidebar +sidebar_positition: 40 +slug: /restful/Compact +title: "Compact Collection | RESTful" +description: "This operation compacts the collection by merging small segments into larger ones. It is recommended to call this operation after inserting a large amount of data into a collection. | RESTful" +hide_table_of_contents: true +sidebar_label: "Compact Collection" +sidebar_custom_props: { badges: ['post']} +keywords: + - zilliz cloud + - zilliz + - cloud + - "Compact Collection" + - "post" + - RESTful + - API +--- + +# Compact Collection + +import RestSpecs from '@site/src/components/RestSpecs'; + + + +export const specs = {"summary":"Compact Collection","deprecated":false,"description":"This operation compacts the collection by merging small segments into larger ones. It is recommended to call this operation after inserting a large amount of data into a collection.","x-i18n":{"zh-CN":{"summary":"Compact Collection","description":"本操作完成体积较小的 Segment 的合并。建议在插入大量数据之后再调用此操作。"}},"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":{"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 将导致错误。"}}}},"required":["collectionName"]},"example":{"collectionName":"test_collection"}}}},"responses":{"200":{"description":"Return an empty response.","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":"响应码。"}}},"data":{"type":"object","properties":{}}}},{"x-tab-label":"failure","description":"Returns an error message.","x-i18n":{"zh-CN":{"description":"返回错误消息。"}},"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":1800,"message":"User hasn't authenticated"}}}}}}}} +export const endpoint = "/v2/vectordb/collections/compact" +export const method = "post" diff --git a/API_Reference_MDX/milvus-restful/v2.5.x/v2/Collection (v2)/Create.mdx b/API_Reference_MDX/milvus-restful/v2.5.x/v2/Collection (v2)/Create.mdx index 296392e15..bae84db63 100644 --- a/API_Reference_MDX/milvus-restful/v2.5.x/v2/Collection (v2)/Create.mdx +++ b/API_Reference_MDX/milvus-restful/v2.5.x/v2/Collection (v2)/Create.mdx @@ -1,12 +1,20 @@ --- displayed_sidebar: restfulSidebar -sidebar_positition: 29 +sidebar_positition: 35 slug: /restful/Create title: "Create Collection | RESTful" description: "This operation creates a collection in a specified cluster. | RESTful" hide_table_of_contents: true sidebar_label: "Create Collection" sidebar_custom_props: { badges: ['post']} +keywords: + - zilliz cloud + - zilliz + - cloud + - "Create Collection" + - "post" + - RESTful + - API --- # Create Collection @@ -15,6 +23,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":"数据库名称。"}}},"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":"数据库名称。"}}},"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，则该参数为必填项，用于设置该字段值的最大元素数量。"}}},"enable_analyzer":{"type":"boolean","description":"Whether to enable text analysis for the specified `VARCHAR` field. When set to `true`, it instructs Milvus to use a text analyzer, which tokenizes and filters the text content of the field.","x-i18n":{"zh-CN":{"description":"是否为指定 `VARCHAR` 字段启用文本分析。设置为 `true` 时，Milvus 会使用 Analyzer 对该字段的文本内容进行分词和过滤。"}},"x-include-target":["milvus"]},"analyzer_params":{"type":"object","properties":{"type":{"type":"string","description":"Pre-configured analyzer type built into Milvus, which can be used out-of-the-box by specifying its name. Possible values: `standard`, `english`, `chinese`. ","x-i18n":{"zh-CN":{"descripiton":"预配置的 Analyzer 类型，可通过指定名称使用。可选值：`standard`、`english`、`chinese`。"}}},"tokenizer":{"type":"string","description":"Defines the tokenizer type. Possible values: `standard` (default), `whitespace`, `jieba`.","x-i18n":{"zh-CN":{"description":"定义分词器类型。可选值：`standard`（默认），`whitespace`，`jieba`。"}}},"filter":{"type":"array","description":"Lists filters to refine tokens produced by the tokenizer, with options for built-in filters and custom filters.","x-i18n":{"zh-CN":{"description":"定义过滤器列表，用于对分词器产生的词进行过滤，可选内置过滤器和自定义过滤器。"}}}},"description":"Configures the analyzer for text processing, specifically for `DataType.VARCHAR` fields.","x-i18n":{"zh-CN":{"description":"用于处理 `DataType.VARCHAR` 字段的文本分析器配置。"}},"x-include-target":["milvus"]},"enable_match":{"type":"boolean","description":" Whether to enable keyword matching for the specified `VARCHAR` field. When set to `true`, Milvus creates an inverted index for the field, allowing for quick and efficient keyword lookups. `enable_match` works in conjunction with `enable_analyzer` to provide structured keyword-based text search, with `enable_analyzer` handling tokenization and `enable_match` handling the search operations on these tokens.","x-i18n":{"zh-CN":{"description":"是否为指定 `VARCHAR` 字段启用关键词匹配。设置为 `true` 时，Milvus 会为该字段创建倒排索引，以支持快速和高效的关键词查询。`enable_match` 与 `enable_analyzer` 配合使用，以提供结构化的基于关键词的文本搜索，`enable_analyzer` 负责对文本内容进行分词和过滤，`enable_match` 负责对这些词进行搜索操作。"}},"x-include-target":["milvus"]}},"description":"Extra field parameters.","x-i18n":{"zh-CN":{"description":"字段附加参数。"}}},"defaultValue":{"type":"object","description":"The default value for the field, applicable only to scalar fields that are not primary fields.","x-i18n":{"zh-CN":{"description":"字段的默认值，仅适用于非主键字段的标量字段。"}},"x-include-target":["milvus"]},"nullable":{"type":"boolean","description":"Whether the field can be null. Defaults to `false`.","x-i18n":{"zh-CN":{"description":"字段是否可以为空。默认为 `false`。"}},"x-include-target":["milvus"]}},"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 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":"数据库名称。"}}},"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":"数据库名称。"}}},"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":"string","description":"The consistency level of the collection.","x-i18n":{"zh-CN":{"description":"当前 Collection 的一致性级别。"}},"enum":["Strong","Eventually","Session","Bounded"],"default":"Bounded"},"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":1800,"message":"User hasn't authenticated"}}}}}}},"security":[]} export const endpoint = "/v2/vectordb/collections/create" export const method = "post" diff --git a/API_Reference_MDX/milvus-restful/v2.5.x/v2/Collection (v2)/Describe.mdx b/API_Reference_MDX/milvus-restful/v2.5.x/v2/Collection (v2)/Describe.mdx index 7073849ee..80d8e8460 100644 --- a/API_Reference_MDX/milvus-restful/v2.5.x/v2/Collection (v2)/Describe.mdx +++ b/API_Reference_MDX/milvus-restful/v2.5.x/v2/Collection (v2)/Describe.mdx @@ -1,12 +1,20 @@ --- displayed_sidebar: restfulSidebar -sidebar_positition: 47 +sidebar_positition: 57 slug: /restful/Describe title: "Describe Collection | RESTful" description: "Describes the details of a collection. | RESTful" hide_table_of_contents: true sidebar_label: "Describe Collection" sidebar_custom_props: { badges: ['post']} +keywords: + - zilliz cloud + - zilliz + - cloud + - "Describe Collection" + - "post" + - RESTful + - API --- # Describe Collection @@ -15,6 +23,6 @@ import RestSpecs from '@site/src/components/RestSpecs'; -export const specs = {"summary":"Describe Collection","deprecated":false,"description":"Describes the details of a 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 the database.","x-i18n":{"zh-CN":{"description":"数据库名称。"}},"x-include-target":["milvus"]},"collectionName":{"type":"string","description":"The name of the collection to describe.","x-i18n":{"zh-CN":{"description":"Collection 名称。"}}}},"required":["collectionName"]},"example":{"collectionName":"test_collection"}}}},"responses":{"200":{"description":"Returns the specified collection in detail.","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 detailed information about the specified collection.","x-i18n":{"zh-CN":{"description":"响应负载，包含了指定 Collection 的详细信息。"}},"properties":{"aliases":{"type":"array","items":{"type":"string","description":"An alias of the collection.","x-i18n":{"zh-CN":{"description":"Collection 的别名。"}}},"description":"A list aliases assigned to the collection.","x-i18n":{"zh-CN":{"description":"已分配给 Collection 的别名列表。"}}},"autoID":{"type":"boolean","description":"Whether the primary key of this collection automatically increments.","x-i18n":{"zh-CN":{"description":"当前 Collection 的主键是否自动增长。"}}},"collectionID":{"type":"integer","format":"int64","description":"The ID assigned to the collection upon creation.","x-i18n":{"zh-CN":{"description":"创建当前 Collection 时分配的 ID。"}}},"collectionName":{"type":"string","description":"The name of the current collection.","x-i18n":{"zh-CN":{"description":"当前 Collection 的名称。"}}},"consistencyLevel":{"type":"string","description":"The consistency level of the current collection.","x-i18n":{"zh-CN":{"description":"当前 Collection 的一致性级别。"}},"enum":["Strong","Bounded","Session","Eventual"]},"description":{"type":"string","description":"The description of the collection.","x-i18n":{"zh-CN":{"description":"当前 Collection 的描述。"}}},"enableDynamicField":{"type":"boolean","description":"Whether the reserved dynamic field named $meta is enabled to save non-schema-defined fields and their values in key-value pairs.","x-i18n":{"zh-CN":{"description":"是否已启用保留的动态字段，用于以键值对的形式存放 Schema 中未定义的字段。"}}},"fields":{"type":"array","items":{"type":"object","properties":{"autoId":{"type":"boolean","description":"Whether this field automatically increments its value.","x-i18n":{"zh-CN":{"description":"当前字段是否自动增长。"}}},"description":{"type":"string","description":"The description of the field.","x-i18n":{"zh-CN":{"description":"当前字段的描述。"}}},"id":{"type":"integer","description":"The field ID.","x-i18n":{"zh-CN":{"description":"当前字段的 ID。"}}},"name":{"type":"string","description":"The name of the current field.","x-i18n":{"zh-CN":{"description":"当前字段的名称。"}}},"params":{"type":"array","items":{"type":"object","properties":{"key":{"type":"string","description":"Field parameter name.","x-i18n":{"zh-CN":{"description":"字段参数名称。"}}},"value":{"type":"string","description":"Field parameter value.","x-i18n":{"zh-CN":{"description":"字段参数取值。"}}}},"description":"A field parameter in a key-value pair","x-i18n":{"zh-CN":{"description":"以键值对形式呈现的字段配置项。"}}},"description":"Other field parameters.","x-i18n":{"zh-CN":{"description":"其它字段参数。"}}},"partitionKey":{"type":"boolean","description":"Whether this field serves as a partition key.","x-i18n":{"zh-CN":{"description":"当前字段是否为 Partition Key。"}}},"primaryKey":{"type":"boolean","description":"Whether this field serves as the primary key.","x-i18n":{"zh-CN":{"description":"当前字段是否为主键。"}}},"type":{"type":"string","description":"The data type of the field.","x-i18n":{"zh-CN":{"description":"当前字段值的数据类型。"}}}},"description":"A field object.","x-i18n":{"zh-CN":{"description":"字段对象。"}}},"description":"The collection fields in an array","x-i18n":{"zh-CN":{"description":"当前 Collection 的字段列表。"}}},"indexes":{"type":"array","items":{"type":"object","properties":{"fieldName":{"type":"string","description":"The target field of this index.","x-i18n":{"zh-CN":{"description":"当前索引对应的字段名称。"}}},"indexName":{"type":"string","description":"The name of this index.","x-i18n":{"zh-CN":{"description":"当前索引的名称。"}}},"metricType":{"type":"string","description":"The metric type of this index.","x-i18n":{"zh-CN":{"description":"当前索引使用的相似性度量方式。"}}}},"description":"A index object","x-i18n":{"zh-CN":{"description":"索引对象。"}}},"description":"The created indexes in an array","x-i18n":{"zh-CN":{"description":"索引列表。"}}},"load":{"type":"string","description":"The load status of the current collection.","x-i18n":{"zh-CN":{"description":"当前 Collection 的载入状态。"}}},"partitionNum":{"type":"integer","description":"The number of partitions in the collection.","x-i18n":{"zh-CN":{"description":"当前 Collection 的 Partition 数量。"}}},"properties":{"type":"array","items":{"type":"object","properties":{"key":{"type":"string","description":"The property name","x-i18n":{"zh-CN":{"description":"属性名称。"}}},"value":{"type":"string","description":"The property value.","x-i18n":{"zh-CN":{"description":"属性取值。"}}}},"description":"A collection property object in a key-value pair.","x-i18n":{"zh-CN":{"description":"以键值对形式呈现的 Collection 属性。"}}},"description":"Extra collection properties in an array.","x-i18n":{"zh-CN":{"description":"当前 Collection 的额外属性。"}}},"shardsNum":{"type":"integer","description":"The number of shards created along with the collection.","x-i18n":{"zh-CN":{"description":"随当前 Collection 创建的 Shard 数量。"}},"x-include-target":["milvus"]}}}}},{"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","x-include-target":["milvus"],"value":{"code":0,"data":{"aliases":[],"autoId":false,"collectionID":448707763883002000,"collectionName":"test_collection","consistencyLevel":"Bounded","description":"","enableDynamicField":true,"fields":[{"autoId":false,"description":"","id":100,"name":"id","partitionKey":false,"primaryKey":true,"type":"Int64"},{"autoId":false,"description":"","id":101,"name":"vector","params":[{"key":"dim","value":"5"}],"partitionKey":false,"primaryKey":false,"type":"FloatVector"}],"indexes":[{"fieldName":"vector","indexName":"vector","metricType":"COSINE"}],"load":"LoadStateLoaded","partitionsNum":1,"properties":[],"shardsNum":1}}},"2":{"summary":"success","x-target-response":"OPTION 1","x-include-target":["zilliz"],"value":{"code":0,"data":{"aliases":[],"autoId":false,"collectionID":448707763883002000,"collectionName":"test_collection","consistencyLevel":"Bounded","description":"","enableDynamicField":true,"fields":[{"autoId":false,"description":"","id":100,"name":"id","partitionKey":false,"primaryKey":true,"type":"Int64"},{"autoId":false,"description":"","id":101,"name":"vector","params":[{"key":"dim","value":"5"}],"partitionKey":false,"primaryKey":false,"type":"FloatVector"}],"indexes":[{"fieldName":"vector","indexName":"vector","metricType":"COSINE"}],"load":"LoadStateLoaded","partitionsNum":1,"properties":[]}}},"3":{"summary":"failure","x-target-response":"OPTION 2","value":{"code":0,"message":"The token is illegal."}}}}}}},"security":[]} +export const specs = {"summary":"Describe Collection","deprecated":false,"description":"Describes the details of a 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 the database.","x-i18n":{"zh-CN":{"description":"数据库名称。"}}},"collectionName":{"type":"string","description":"The name of the collection to describe.","x-i18n":{"zh-CN":{"description":"Collection 名称。"}}}},"required":["collectionName"]},"example":{"collectionName":"test_collection"}}}},"responses":{"200":{"description":"Returns the specified collection in detail.","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 detailed information about the specified collection.","x-i18n":{"zh-CN":{"description":"响应负载，包含了指定 Collection 的详细信息。"}},"properties":{"aliases":{"type":"array","items":{"type":"string","description":"An alias of the collection.","x-i18n":{"zh-CN":{"description":"Collection 的别名。"}}},"description":"A list aliases assigned to the collection.","x-i18n":{"zh-CN":{"description":"已分配给 Collection 的别名列表。"}}},"autoID":{"type":"boolean","description":"Whether the primary key of this collection automatically increments.","x-i18n":{"zh-CN":{"description":"当前 Collection 的主键是否自动增长。"}}},"collectionID":{"type":"integer","format":"int64","description":"The ID assigned to the collection upon creation.","x-i18n":{"zh-CN":{"description":"创建当前 Collection 时分配的 ID。"}}},"collectionName":{"type":"string","description":"The name of the current collection.","x-i18n":{"zh-CN":{"description":"当前 Collection 的名称。"}}},"consistencyLevel":{"type":"string","description":"The consistency level of the current collection.","x-i18n":{"zh-CN":{"description":"当前 Collection 的一致性级别。"}},"enum":["Strong","Bounded","Session","Eventual"]},"description":{"type":"string","description":"The description of the collection.","x-i18n":{"zh-CN":{"description":"当前 Collection 的描述。"}}},"enableDynamicField":{"type":"boolean","description":"Whether the reserved dynamic field named $meta is enabled to save non-schema-defined fields and their values in key-value pairs.","x-i18n":{"zh-CN":{"description":"是否已启用保留的动态字段，用于以键值对的形式存放 Schema 中未定义的字段。"}}},"fields":{"type":"array","items":{"type":"object","properties":{"autoId":{"type":"boolean","description":"Whether this field automatically increments its value.","x-i18n":{"zh-CN":{"description":"当前字段是否自动增长。"}}},"description":{"type":"string","description":"The description of the field.","x-i18n":{"zh-CN":{"description":"当前字段的描述。"}}},"id":{"type":"integer","description":"The field ID.","x-i18n":{"zh-CN":{"description":"当前字段的 ID。"}}},"name":{"type":"string","description":"The name of the current field.","x-i18n":{"zh-CN":{"description":"当前字段的名称。"}}},"params":{"type":"array","items":{"type":"object","properties":{"key":{"type":"string","description":"Field parameter name.","x-i18n":{"zh-CN":{"description":"字段参数名称。"}}},"value":{"type":"string","description":"Field parameter value.","x-i18n":{"zh-CN":{"description":"字段参数取值。"}}}},"description":"A field parameter in a key-value pair","x-i18n":{"zh-CN":{"description":"以键值对形式呈现的字段配置项。"}}},"description":"Other field parameters.","x-i18n":{"zh-CN":{"description":"其它字段参数。"}}},"partitionKey":{"type":"boolean","description":"Whether this field serves as a partition key.","x-i18n":{"zh-CN":{"description":"当前字段是否为 Partition Key。"}}},"primaryKey":{"type":"boolean","description":"Whether this field serves as the primary key.","x-i18n":{"zh-CN":{"description":"当前字段是否为主键。"}}},"type":{"type":"string","description":"The data type of the field.","x-i18n":{"zh-CN":{"description":"当前字段值的数据类型。"}}}},"description":"A field object.","x-i18n":{"zh-CN":{"description":"字段对象。"}}},"description":"The collection fields in an array","x-i18n":{"zh-CN":{"description":"当前 Collection 的字段列表。"}}},"indexes":{"type":"array","items":{"type":"object","properties":{"fieldName":{"type":"string","description":"The target field of this index.","x-i18n":{"zh-CN":{"description":"当前索引对应的字段名称。"}}},"indexName":{"type":"string","description":"The name of this index.","x-i18n":{"zh-CN":{"description":"当前索引的名称。"}}},"metricType":{"type":"string","description":"The metric type of this index.","x-i18n":{"zh-CN":{"description":"当前索引使用的相似性度量方式。"}}}},"description":"A index object","x-i18n":{"zh-CN":{"description":"索引对象。"}}},"description":"The created indexes in an array","x-i18n":{"zh-CN":{"description":"索引列表。"}}},"load":{"type":"string","description":"The load status of the current collection.","x-i18n":{"zh-CN":{"description":"当前 Collection 的载入状态。"}}},"partitionNum":{"type":"integer","description":"The number of partitions in the collection.","x-i18n":{"zh-CN":{"description":"当前 Collection 的 Partition 数量。"}}},"properties":{"type":"array","items":{"type":"object","properties":{"key":{"type":"string","description":"The property name","x-i18n":{"zh-CN":{"description":"属性名称。"}}},"value":{"type":"string","description":"The property value.","x-i18n":{"zh-CN":{"description":"属性取值。"}}}},"description":"A collection property object in a key-value pair.","x-i18n":{"zh-CN":{"description":"以键值对形式呈现的 Collection 属性。"}}},"description":"Extra collection properties in an array.","x-i18n":{"zh-CN":{"description":"当前 Collection 的额外属性。"}}},"shardsNum":{"type":"integer","description":"The number of shards created along with the collection.","x-i18n":{"zh-CN":{"description":"随当前 Collection 创建的 Shard 数量。"}},"x-include-target":["milvus"]}}}}},{"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","x-include-target":["milvus"],"value":{"code":0,"data":{"aliases":[],"autoId":false,"collectionID":448707763883002000,"collectionName":"test_collection","consistencyLevel":"Bounded","description":"","enableDynamicField":true,"fields":[{"autoId":false,"description":"","id":100,"name":"id","partitionKey":false,"primaryKey":true,"type":"Int64"},{"autoId":false,"description":"","id":101,"name":"vector","params":[{"key":"dim","value":"5"}],"partitionKey":false,"primaryKey":false,"type":"FloatVector"}],"indexes":[{"fieldName":"vector","indexName":"vector","metricType":"COSINE"}],"load":"LoadStateLoaded","partitionsNum":1,"properties":[],"shardsNum":1}}},"2":{"summary":"success","x-target-response":"OPTION 1","x-include-target":["zilliz"],"value":{"code":0,"data":{"aliases":[],"autoId":false,"collectionID":448707763883002000,"collectionName":"test_collection","consistencyLevel":"Bounded","description":"","enableDynamicField":true,"fields":[{"autoId":false,"description":"","id":100,"name":"id","partitionKey":false,"primaryKey":true,"type":"Int64"},{"autoId":false,"description":"","id":101,"name":"vector","params":[{"key":"dim","value":"5"}],"partitionKey":false,"primaryKey":false,"type":"FloatVector"}],"indexes":[{"fieldName":"vector","indexName":"vector","metricType":"COSINE"}],"load":"LoadStateLoaded","partitionsNum":1,"properties":[]}}},"3":{"summary":"failure","x-target-response":"OPTION 2","value":{"code":1800,"message":"User hasn't authenticated"}}}}}}},"security":[]} export const endpoint = "/v2/vectordb/collections/describe" export const method = "post" diff --git a/API_Reference_MDX/milvus-restful/v2.5.x/v2/Collection (v2)/Drop Properties.mdx b/API_Reference_MDX/milvus-restful/v2.5.x/v2/Collection (v2)/Drop Properties.mdx new file mode 100644 index 000000000..7ecf35861 --- /dev/null +++ b/API_Reference_MDX/milvus-restful/v2.5.x/v2/Collection (v2)/Drop Properties.mdx @@ -0,0 +1,28 @@ +--- +displayed_sidebar: restfulSidebar +sidebar_positition: 97 +slug: /restful/Drop Properties +title: "Drop Collection Properties | RESTful" +description: "This operation drops the properties of a collection. | RESTful" +hide_table_of_contents: true +sidebar_label: "Drop Collection Properties" +sidebar_custom_props: { badges: ['post']} +keywords: + - zilliz cloud + - zilliz + - cloud + - "Drop Collection Properties" + - "post" + - RESTful + - API +--- + +# Drop Collection Properties + +import RestSpecs from '@site/src/components/RestSpecs'; + + + +export const specs = {"summary":"Drop Collection Properties","deprecated":false,"description":"This operation drops the properties of a 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 the database which the collection belongs to. Setting this to a non-existing database results in an error.","x-i18n":{"zh-CN":{"description":"Database 名称。"}}},"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 名称。"}}},"propertyKeys":{"type":"array","description":"The names of the properties to drop.","x-i18n":{"zh-CN":{"description":"待删除的属性名称列表。"}},"items":{"type":"string","description":"The name of the property to drop.","x-i18n":{"zh-CN":{"description":"待删除的属性名称。"}},"enum":["mmap.enabled","collection.ttl.seconds","partitionkey.isolation"]}}},"required":["collectionName","propertyKeys"]},"example":{"collectionName":"test_collection","propertyKeys":["mmap.enabled"]}}}},"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":"响应码。"}}},"data":{"type":"object","properties":{}}}},{"x-tab-label":"failure","description":"Returns an error message.","x-i18n":{"zh-CN":{"description":"返回错误消息。"}},"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":1800,"message":"User hasn't authenticated"}}}}}}}} +export const endpoint = "/v2/vectordb/collections/drop_properties" +export const method = "post" diff --git a/API_Reference_MDX/milvus-restful/v2.5.x/v2/Collection (v2)/Drop.mdx b/API_Reference_MDX/milvus-restful/v2.5.x/v2/Collection (v2)/Drop.mdx index 63bedc437..d5fc5488e 100644 --- a/API_Reference_MDX/milvus-restful/v2.5.x/v2/Collection (v2)/Drop.mdx +++ b/API_Reference_MDX/milvus-restful/v2.5.x/v2/Collection (v2)/Drop.mdx @@ -1,12 +1,20 @@ --- displayed_sidebar: restfulSidebar -sidebar_positition: 62 +sidebar_positition: 72 slug: /restful/Drop title: "Drop Collection | RESTful" description: "This operation drops the current collection and all data within the collection. | RESTful" hide_table_of_contents: true sidebar_label: "Drop Collection" sidebar_custom_props: { badges: ['post']} +keywords: + - zilliz cloud + - zilliz + - cloud + - "Drop Collection" + - "post" + - RESTful + - API --- # Drop Collection @@ -15,6 +23,6 @@ import RestSpecs from '@site/src/components/RestSpecs'; -export const specs = {"summary":"Drop Collection","deprecated":false,"description":"This operation drops the current collection and all data within the 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 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 将导致错误。"}}}},"required":["collectionName"],"x-i18n-langs":["zh-CN"]},"example":{"collectionName":"my_collection"}}}},"responses":{"200":{"description":"None","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":"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":[{"bearer":[]}]} +export const specs = {"summary":"Drop Collection","deprecated":false,"description":"This operation drops the current collection and all data within the 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 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 所属的数据库名称。设置为不存在的数据库将导致错误。"}}},"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 将导致错误。"}}}},"required":["collectionName"],"x-i18n-langs":["zh-CN"]},"example":{"collectionName":"my_collection"}}}},"responses":{"200":{"description":"None","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":"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":1800,"message":"User hasn't authenticated"}}}}}}},"security":[{"bearer":[]}]} export const endpoint = "/v2/vectordb/collections/drop" export const method = "post" diff --git a/API_Reference_MDX/milvus-restful/v2.5.x/v2/Collection (v2)/Flush.mdx b/API_Reference_MDX/milvus-restful/v2.5.x/v2/Collection (v2)/Flush.mdx new file mode 100644 index 000000000..cc7cf84c4 --- /dev/null +++ b/API_Reference_MDX/milvus-restful/v2.5.x/v2/Collection (v2)/Flush.mdx @@ -0,0 +1,28 @@ +--- +displayed_sidebar: restfulSidebar +sidebar_positition: 39 +slug: /restful/Flush +title: "Flush Collection | RESTful" +description: "This operation flushes the streaming data and seals segments. It is recommended to call this operation after all the data has been inserted into a collection. | RESTful" +hide_table_of_contents: true +sidebar_label: "Flush Collection" +sidebar_custom_props: { badges: ['post']} +keywords: + - zilliz cloud + - zilliz + - cloud + - "Flush Collection" + - "post" + - RESTful + - API +--- + +# Flush Collection + +import RestSpecs from '@site/src/components/RestSpecs'; + + + +export const specs = {"summary":"Flush Collection","deprecated":false,"description":"This operation flushes the streaming data and seals segments. It is recommended to call this operation after all the data has been inserted into a collection.","x-i18n":{"zh-CN":{"summary":"Flush Collection","description":"本接口完成流式数据落盘并封存 Segment。建议在插入所有数据之后再调用此接口。"}},"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 that to which the collection belongs .\nSetting this to a non-existing database results in an error.","x-i18n":{"zh-CN":{"description":"Collection 所属的数据库名称。设置为不存在的数据库将导致错误。"}}},"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 将导致错误。"}}}},"required":["collectionName"]},"example":{"collectionName":"test_collection"}}}},"responses":{"200":{"description":"Return an empty response.","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":"响应码。"}}},"data":{"type":"object","properties":{}}}},{"x-tab-label":"failure","description":"Returns an error message.","x-i18n":{"zh-CN":{"description":"返回错误消息。"}},"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":1800,"message":"User hasn't authenticated"}}}}}}}} +export const endpoint = "/v2/vectordb/collections/flush" +export const method = "post" diff --git a/API_Reference_MDX/milvus-restful/v2.5.x/v2/Collection (v2)/Get Load State.mdx b/API_Reference_MDX/milvus-restful/v2.5.x/v2/Collection (v2)/Get Load State.mdx index 5c9d77720..964153876 100644 --- a/API_Reference_MDX/milvus-restful/v2.5.x/v2/Collection (v2)/Get Load State.mdx +++ b/API_Reference_MDX/milvus-restful/v2.5.x/v2/Collection (v2)/Get Load State.mdx @@ -1,12 +1,20 @@ --- displayed_sidebar: restfulSidebar -sidebar_positition: 91 +sidebar_positition: 105 slug: /restful/Get Load State title: "Get Collection Load State | RESTful" description: "This operation returns the load status of a specific collection. | RESTful" hide_table_of_contents: true sidebar_label: "Get Collection Load State" sidebar_custom_props: { badges: ['post']} +keywords: + - zilliz cloud + - zilliz + - cloud + - "Get Collection Load State" + - "post" + - RESTful + - API --- # Get Collection Load State @@ -15,6 +23,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":"数据库名称。"}}},"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":1800,"message":"User hasn't authenticated"}}}}}}},"security":[]} export const endpoint = "/v2/vectordb/collections/get_load_state" export const method = "post" diff --git a/API_Reference_MDX/milvus-restful/v2.5.x/v2/Collection (v2)/Get Stats.mdx b/API_Reference_MDX/milvus-restful/v2.5.x/v2/Collection (v2)/Get Stats.mdx index c98aea5d2..767427e68 100644 --- a/API_Reference_MDX/milvus-restful/v2.5.x/v2/Collection (v2)/Get Stats.mdx +++ b/API_Reference_MDX/milvus-restful/v2.5.x/v2/Collection (v2)/Get Stats.mdx @@ -1,12 +1,20 @@ --- displayed_sidebar: restfulSidebar -sidebar_positition: 83 +sidebar_positition: 93 slug: /restful/Get Stats title: "Get Collection Stats | RESTful" description: "This operation gets the number of entities in a collection. | RESTful" hide_table_of_contents: true sidebar_label: "Get Collection Stats" sidebar_custom_props: { badges: ['post']} +keywords: + - zilliz cloud + - zilliz + - cloud + - "Get Collection Stats" + - "post" + - RESTful + - API --- # Get Collection Stats @@ -15,6 +23,6 @@ import RestSpecs from '@site/src/components/RestSpecs'; -export const specs = {"summary":"Get Collection Stats","deprecated":false,"description":"This operation gets the number of entities in a collection.","x-i18n":{"zh-CN":{"summary":"获取 Collection 统计信息","description":"本接口可以获取 Collection 中的 Entity 数量。"}},"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 which the collection belongs to. Setting this to a non-existing database results in an error.","x-i18n":{"zh-CN":{"description":"数据库名称。"}},"x-include-target":["milvus"]},"collectionName":{"type":"string","description":"The name of the collection to check.\nSetting this to a non-existing collection results in an error.","x-i18n":{"zh-CN":{"description":"Collection 名称。"}}}},"required":["collectionName"]},"example":{"collectionName":"quick_setup"}}}},"responses":{"200":{"description":"The number of entities in a collection.","x-i18n":{"zh-CN":{"description":"指定 Collection 中的 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 collection","x-i18n":{"zh-CN":{"description":"指定 Collection 的统计信息。"}},"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 Collection Stats","deprecated":false,"description":"This operation gets the number of entities in a collection.","x-i18n":{"zh-CN":{"summary":"获取 Collection 统计信息","description":"本接口可以获取 Collection 中的 Entity 数量。"}},"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 which the collection belongs to. Setting this to a non-existing database results in an error.","x-i18n":{"zh-CN":{"description":"数据库名称。"}}},"collectionName":{"type":"string","description":"The name of the collection to check.\nSetting this to a non-existing collection results in an error.","x-i18n":{"zh-CN":{"description":"Collection 名称。"}}}},"required":["collectionName"]},"example":{"collectionName":"quick_setup"}}}},"responses":{"200":{"description":"The number of entities in a collection.","x-i18n":{"zh-CN":{"description":"指定 Collection 中的 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 collection","x-i18n":{"zh-CN":{"description":"指定 Collection 的统计信息。"}},"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":1800,"message":"User hasn't authenticated"}}}}}}},"security":[]} export const endpoint = "/v2/vectordb/collections/get_stats" export const method = "post" diff --git a/API_Reference_MDX/milvus-restful/v2.5.x/v2/Collection (v2)/Has.mdx b/API_Reference_MDX/milvus-restful/v2.5.x/v2/Collection (v2)/Has.mdx index 9605b1ed5..0f08c2b14 100644 --- a/API_Reference_MDX/milvus-restful/v2.5.x/v2/Collection (v2)/Has.mdx +++ b/API_Reference_MDX/milvus-restful/v2.5.x/v2/Collection (v2)/Has.mdx @@ -1,12 +1,20 @@ --- displayed_sidebar: restfulSidebar -sidebar_positition: 71 +sidebar_positition: 81 slug: /restful/Has title: "Has Collection | RESTful" description: "This operation checks whether a collection exists. | RESTful" hide_table_of_contents: true sidebar_label: "Has Collection" sidebar_custom_props: { badges: ['post']} +keywords: + - zilliz cloud + - zilliz + - cloud + - "Has Collection" + - "post" + - RESTful + - API --- # Has Collection @@ -15,6 +23,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 所在数据库名称。"}}},"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":1800,"message":"User hasn't authenticated"}}}}}}},"security":[]} export const endpoint = "/v2/vectordb/collections/has" export const method = "post" diff --git a/API_Reference_MDX/milvus-restful/v2.5.x/v2/Collection (v2)/List.mdx b/API_Reference_MDX/milvus-restful/v2.5.x/v2/Collection (v2)/List.mdx index c81eab2c8..640911f10 100644 --- a/API_Reference_MDX/milvus-restful/v2.5.x/v2/Collection (v2)/List.mdx +++ b/API_Reference_MDX/milvus-restful/v2.5.x/v2/Collection (v2)/List.mdx @@ -1,12 +1,20 @@ --- displayed_sidebar: restfulSidebar -sidebar_positition: 8 +sidebar_positition: 14 slug: /restful/List title: "List Collections | RESTful" description: "This operation lists all collection names. | RESTful" hide_table_of_contents: true sidebar_label: "List Collections" sidebar_custom_props: { badges: ['post']} +keywords: + - zilliz cloud + - zilliz + - cloud + - "List Collections" + - "post" + - RESTful + - API --- # List Collections @@ -15,6 +23,6 @@ import RestSpecs from '@site/src/components/RestSpecs'; -export const specs = {"summary":"List Collections","deprecated":false,"description":"This operation lists all collection names.","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 an existing database.","x-i18n":{"zh-CN":{"description":"现有数据库名称。"}}}}},"example":{"dbName":"_default"}}}},"responses":{"200":{"description":"This operation lists all collections in the database used in the current connection.","x-i18n":{"zh-CN":{"description":"该操作列出当前连接中使用的数据库中的所有 Collection。"}},"content":{"application/json":{"schema":{"oneOf":[{"x-tab-label":"success","type":"object","properties":{"code":{"description":"Response code.","x-i18n":{"zh-CN":{"description":"响应码。"}},"type":"integer"},"data":{"type":"array","items":{"type":"string","description":"A collection name.","x-i18n":{"zh-CN":{"description":"Collection 名称。"}}},"description":"Response payload which is a list of collection names.","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":["quick_setup_new","customized_setup_1","customized_setup_2"]}},"2":{"summary":"failure","x-target-response":"OPTION 2","value":{"code":0,"message":"The token is illegal."}}}}}}},"security":[]} +export const specs = {"summary":"List Collections","deprecated":false,"description":"This operation lists all collection names.","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 an existing database.","x-i18n":{"zh-CN":{"description":"现有数据库名称。"}}}}},"example":{"dbName":"_default"}}}},"responses":{"200":{"description":"This operation lists all collections in the database used in the current connection.","x-i18n":{"zh-CN":{"description":"该操作列出当前连接中使用的数据库中的所有 Collection。"}},"content":{"application/json":{"schema":{"oneOf":[{"x-tab-label":"success","type":"object","properties":{"code":{"description":"Response code.","x-i18n":{"zh-CN":{"description":"响应码。"}},"type":"integer"},"data":{"type":"array","items":{"type":"string","description":"A collection name.","x-i18n":{"zh-CN":{"description":"Collection 名称。"}}},"description":"Response payload which is a list of collection names.","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":["quick_setup_new","customized_setup_1","customized_setup_2"]}},"2":{"summary":"failure","x-target-response":"OPTION 2","value":{"code":1800,"message":"User hasn't authenticated"}}}}}}},"security":[]} export const endpoint = "/v2/vectordb/collections/list" export const method = "post" diff --git a/API_Reference_MDX/milvus-restful/v2.5.x/v2/Collection (v2)/Load.mdx b/API_Reference_MDX/milvus-restful/v2.5.x/v2/Collection (v2)/Load.mdx index ef76b6818..3aa608a5d 100644 --- a/API_Reference_MDX/milvus-restful/v2.5.x/v2/Collection (v2)/Load.mdx +++ b/API_Reference_MDX/milvus-restful/v2.5.x/v2/Collection (v2)/Load.mdx @@ -1,12 +1,20 @@ --- displayed_sidebar: restfulSidebar -sidebar_positition: 87 +sidebar_positition: 101 slug: /restful/Load title: "Load Collection | RESTful" description: "This operation loads the data of the current collection into memory. | RESTful" hide_table_of_contents: true sidebar_label: "Load Collection" sidebar_custom_props: { badges: ['post']} +keywords: + - zilliz cloud + - zilliz + - cloud + - "Load Collection" + - "post" + - RESTful + - API --- # Load Collection @@ -15,6 +23,6 @@ import RestSpecs from '@site/src/components/RestSpecs'; -export const specs = {"summary":"Load Collection","deprecated":false,"description":"This operation loads the data of the current collection into memory. ","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 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 将导致错误。"}}}},"required":["collectionName"]},"example":{"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":0,"message":"The token is illegal."}}}}}}},"security":[]} +export const specs = {"summary":"Load Collection","deprecated":false,"description":"This operation loads the data of the current collection into memory. ","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 that to which the collection belongs .\nSetting this to a non-existing database results in an error.","x-i18n":{"zh-CN":{"description":"Collection 所属的数据库名称。设置为不存在的数据库将导致错误。"}}},"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 将导致错误。"}}}},"required":["collectionName"]},"example":{"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":1800,"message":"User hasn't authenticated"}}}}}}},"security":[]} export const endpoint = "/v2/vectordb/collections/load" export const method = "post" diff --git a/API_Reference_MDX/milvus-restful/v2.5.x/v2/Collection (v2)/Release.mdx b/API_Reference_MDX/milvus-restful/v2.5.x/v2/Collection (v2)/Release.mdx index c3c4e10e6..d1430b733 100644 --- a/API_Reference_MDX/milvus-restful/v2.5.x/v2/Collection (v2)/Release.mdx +++ b/API_Reference_MDX/milvus-restful/v2.5.x/v2/Collection (v2)/Release.mdx @@ -1,12 +1,20 @@ --- displayed_sidebar: restfulSidebar -sidebar_positition: 89 +sidebar_positition: 103 slug: /restful/Release title: "Release Collection | RESTful" description: "This operation releases the data of the current collection from memory. | RESTful" hide_table_of_contents: true sidebar_label: "Release Collection" sidebar_custom_props: { badges: ['post']} +keywords: + - zilliz cloud + - zilliz + - cloud + - "Release Collection" + - "post" + - RESTful + - API --- # Release Collection @@ -15,6 +23,6 @@ import RestSpecs from '@site/src/components/RestSpecs'; -export const specs = {"summary":"Release Collection","deprecated":false,"description":"This operation releases the data of the current collection from memory.","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 to which the cpllection belongs.","x-i18n":{"zh-CN":{"description":"数据库名称。"}},"x-include-target":["milvus"]},"collectionName":{"type":"string","description":"The name of the target colletion.","x-i18n":{"zh-CN":{"description":"目标 Collection 名称。"}}}},"required":["collectionName"]},"example":{"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":0,"message":"The token is illegal."}}}}}}},"security":[]} +export const specs = {"summary":"Release Collection","deprecated":false,"description":"This operation releases the data of the current collection from memory.","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 to which the cpllection belongs.","x-i18n":{"zh-CN":{"description":"数据库名称。"}}},"collectionName":{"type":"string","description":"The name of the target colletion.","x-i18n":{"zh-CN":{"description":"目标 Collection 名称。"}}}},"required":["collectionName"]},"example":{"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":1800,"message":"User hasn't authenticated"}}}}}}},"security":[]} export const endpoint = "/v2/vectordb/collections/release" export const method = "post" diff --git a/API_Reference_MDX/milvus-restful/v2.5.x/v2/Collection (v2)/Rename.mdx b/API_Reference_MDX/milvus-restful/v2.5.x/v2/Collection (v2)/Rename.mdx index 943633ea0..061140665 100644 --- a/API_Reference_MDX/milvus-restful/v2.5.x/v2/Collection (v2)/Rename.mdx +++ b/API_Reference_MDX/milvus-restful/v2.5.x/v2/Collection (v2)/Rename.mdx @@ -1,12 +1,20 @@ --- displayed_sidebar: restfulSidebar -sidebar_positition: 85 +sidebar_positition: 99 slug: /restful/Rename title: "Rename Collection | RESTful" description: "This operation renames an existing collection and optionally moves the collection to a new database. | RESTful" hide_table_of_contents: true sidebar_label: "Rename Collection" sidebar_custom_props: { badges: ['post']} +keywords: + - zilliz cloud + - zilliz + - cloud + - "Rename Collection" + - "post" + - RESTful + - API --- # Rename Collection @@ -15,6 +23,6 @@ import RestSpecs from '@site/src/components/RestSpecs'; -export const specs = {"summary":"Rename Collection","deprecated":false,"description":"This operation renames an existing collection and optionally moves the collection to a new database.","x-i18n":{"zh-CN":{"summary":"重命名 Collection","description":"本接口重命名指定 Collection。您还可将其移动到指定的数据库中。"}},"tags":["Collection Operations (V2)"],"parameters":[{"name":"Authorization","in":"header","description":"The authentication token","required":true,"example":"Bearer {{TOKEN}}","schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"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 将导致错误。"}}},"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"]},"newDbName":{"type":"string","description":"The name of the database to which the collection belongs after this operation.\nThe value defaults to **default**. Setting this to a database rather than the one the collection belongs to before this operation moves this collection to the specified database.\nSetting this to a non-existing database results in an error.","x-include-target":["milvus"]},"newCollectionName":{"type":"string","description":"The name of the target collection after this operation.\nSetting this to the value of **old_collection_name** results in an error."}},"required":["newCollectionName","collectionName"]},"example":{"collectionName":"test_collection","newCollectionName":"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":0,"message":"The token is illegal."}}}}}}},"security":[]} +export const specs = {"summary":"Rename Collection","deprecated":false,"description":"This operation renames an existing collection and optionally moves the collection to a new database.","x-i18n":{"zh-CN":{"summary":"重命名 Collection","description":"本接口重命名指定 Collection。您还可将其移动到指定的数据库中。"}},"tags":["Collection Operations (V2)"],"parameters":[{"name":"Authorization","in":"header","description":"The authentication token","required":true,"example":"Bearer {{TOKEN}}","schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"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 将导致错误。"}}},"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 所属的数据库名称。设置为不存在的数据库将导致错误。"}}},"newDbName":{"type":"string","description":"The name of the database to which the collection belongs after this operation.\nThe value defaults to **default**. Setting this to a database rather than the one the collection belongs to before this operation moves this collection to the specified database.\nSetting this to a non-existing database results in an error.","x-include-target":["milvus"]},"newCollectionName":{"type":"string","description":"The name of the target collection after this operation.\nSetting this to the value of **old_collection_name** results in an error."}},"required":["newCollectionName","collectionName"]},"example":{"collectionName":"test_collection","newCollectionName":"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":1800,"message":"User hasn't authenticated"}}}}}}},"security":[]} export const endpoint = "/v2/vectordb/collections/rename" export const method = "post" diff --git a/API_Reference_MDX/milvus-restful/v2.5.x/v2/Collection (v2)/alter-field-properties.mdx b/API_Reference_MDX/milvus-restful/v2.5.x/v2/Collection (v2)/alter-field-properties.mdx new file mode 100644 index 000000000..5faa7cac4 --- /dev/null +++ b/API_Reference_MDX/milvus-restful/v2.5.x/v2/Collection (v2)/alter-field-properties.mdx @@ -0,0 +1,28 @@ +--- +displayed_sidebar: restfulSidebar +sidebar_positition: 98 +slug: /restful/alter-field-properties +title: "Alter Field Properties | RESTful" +description: "This operation alters the properties of a field in a collection. | RESTful" +hide_table_of_contents: true +sidebar_label: "Alter Field Properties" +sidebar_custom_props: { badges: ['post']} +keywords: + - zilliz cloud + - zilliz + - cloud + - "Alter Field Properties" + - "post" + - RESTful + - API +--- + +# Alter Field Properties + +import RestSpecs from '@site/src/components/RestSpecs'; + + + +export const specs = {"summary":"Alter Field Properties","deprecated":false,"description":"This operation alters the properties of a field in a collection.","x-i18n":{"zh-CN":{"summary":"修改字段属性","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 which the collection belongs to. Setting this to a non-existing database results in an error.","x-i18n":{"zh-CN":{"description":"Database 名称。"}}},"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 名称。"}}},"fieldName":{"type":"string","description":"The name of the field whose properties are to be altered.","x-i18n":{"zh-CN":{"description":"待修改属性的字段名称。"}}},"fieldParams":{"type":"object","description":"The properties of the field to alter.","x-18n":{"zh-CN":{"description":"待修改的字段属性。"}},"properties":{"max_length":{"type":"integer","description":"The maximum length of the field. Setting this to a non-zero value restricts the maximum length of the field to the specified value.
This parameter applies only when the field is of type `VarChar`.","x-i18n":{"zh-CN":{"description":"字段的最大长度。将该属性设置为非零值将限制字段的最大长度为指定值。
该参数仅适用于 `VarChar` 类型的字段。"}}},"max_capacity":{"type":"integer","description":"The maximum capacity of the field. Setting this to a non-zero value restricts the maximum capacity of the field to the specified value.
This parameter applies only when the field is of type `Array`.","x-i18n":{"zh-CN":{"description":"字段的最大容量。将该属性设置为非零值将限制字段的最大容量为指定值。
该参数仅适用于 `Array` 类型的字段。"}}}}}},"required":["collectionName","fieldName","fieldParams"]},"example":{"collectionName":"test_collection","fieldName":"my_varchar","fieldParams":{"max_length":100}}}}},"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":"响应码。"}}},"data":{"type":"object","properties":{}}}},{"x-tab-label":"failure","description":"Returns an error message.","x-i18n":{"zh-CN":{"description":"返回错误消息。"}},"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":1800,"message":"User hasn't authenticated"}}}}}}}} +export const endpoint = "/v2/vectordb/collections/fields/alter_properties" +export const method = "post" diff --git a/API_Reference_MDX/milvus-restful/v2.5.x/v2/Collection (v2)/refresh-load.mdx b/API_Reference_MDX/milvus-restful/v2.5.x/v2/Collection (v2)/refresh-load.mdx new file mode 100644 index 000000000..dabb66f9f --- /dev/null +++ b/API_Reference_MDX/milvus-restful/v2.5.x/v2/Collection (v2)/refresh-load.mdx @@ -0,0 +1,28 @@ +--- +displayed_sidebar: restfulSidebar +sidebar_positition: 95 +slug: /restful/refresh-load +title: "Refresh Load | RESTful" +description: "This operaton refreshes the load of a collection. | RESTful" +hide_table_of_contents: true +sidebar_label: "Refresh Load" +sidebar_custom_props: { badges: ['post']} +keywords: + - zilliz cloud + - zilliz + - cloud + - "Refresh Load" + - "post" + - RESTful + - API +--- + +# Refresh Load + +import RestSpecs from '@site/src/components/RestSpecs'; + + + +export const specs = {"summary":"Refresh Load","deprecated":false,"description":"This operaton refreshes the load of a 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 the database which the collection belongs to. Setting this to a non-existing database results in an error.","x-i18n":{"zh-CN":{"description":"Database 名称。"}}},"collectionName":{"type":"string","description":"The name of the collection to refresh.\nSetting this to a non-existing collection results in an error.","x-i18n":{"zh-CN":{"description":"Collection 名称。"}}}},"required":["collectionName"]},"example":{"collectionName":"quick_setup"}}}},"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":"响应码。"}}},"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":"返回错误消息。"}},"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":1800,"message":"User hasn't authenticated"}}}}}}}} +export const endpoint = "/v2/vectordb/collections/refresh_load" +export const method = "post" diff --git a/API_Reference_MDX/milvus-restful/v2.5.x/v2/Database (v2)/alter-database-properties.mdx b/API_Reference_MDX/milvus-restful/v2.5.x/v2/Database (v2)/alter-database-properties.mdx new file mode 100644 index 000000000..b8204cd81 --- /dev/null +++ b/API_Reference_MDX/milvus-restful/v2.5.x/v2/Database (v2)/alter-database-properties.mdx @@ -0,0 +1,28 @@ +--- +displayed_sidebar: restfulSidebar +sidebar_positition: 10 +slug: /restful/alter-database-properties +title: "Alter Database Properties | RESTful" +description: "This operation alters the properties of the specified database. | RESTful" +hide_table_of_contents: true +sidebar_label: "Alter Database Properties" +sidebar_custom_props: { badges: ['post']} +keywords: + - zilliz cloud + - zilliz + - cloud + - "Alter Database Properties" + - "post" + - RESTful + - API +--- + +# Alter Database Properties + +import RestSpecs from '@site/src/components/RestSpecs'; + + + +export const specs = {"summary":"Alter Database Properties","deprecated":false,"description":"This operation alters the properties of the specified database.","x-i18n":{"zh-CN":{"summary":"修改 Database 属性","description":"本操作修改指定 Database 的属性。"}},"tags":["Database 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":"目标 Database 名称。"}}},"properties":{"type":"object","description":"The properties to be modified in key-value pairs.","x-i18n":{"zh-CN":{"description":"以键值对的方式提供的要修改的属性。"}},"properties":{"database.replica.number":{"type":"integer","description":"The number of replicas for the specified database.","x-i18n":{"zh-CN":{"description":"指定 Database 的副本数量。"}}},"database.resource_groups":{"type":"string","description":"The names of the resource groups associated with the specified database in a common-separated list.","x-i18n":{"zh-CN":{"description":"与指定 Database 关联的资源组名称，以逗号分隔的列表形式提供。"}}},"database.diskQuota.mb":{"type":"integer","description":"The maximum size of the disk space for the specified database, in megabytes (MB).","x-i18n":{"zh-CN":{"description":"指定 Database 的磁盘空间最大容量，以兆字节 (MB) 为单位。"}}},"database.max.collections":{"type":"integer","description":"The maximum number of collections allowed in the specified database.","x-i18n":{"zh-CN":{"description":"指定 Database 中允许的最大 Collection 数量。"}}},"database.force.deny.writing":{"type":"boolean","description":"Whether to force the specified database to deny writing operations.","x-i18n":{"zh-CN":{"description":"是否强制指定 Database 拒绝写入操作。"}}},"database.force.deny.reading":{"type":"boolean","description":"Whether to force the specified database to deny reading operations.","x-i18n":{"zh-CN":{"description":"是否强制指定 Database 拒绝读取操作。"}}}}}},"required":["dbName","properties"]},"example":{"dbName":"my_database","properties":{"database.replica.number":2}}}}},"responses":{"200":{"description":"Returns an empty response.","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":"响应码。"}}},"data":{"type":"object","description":"An empty response.","x-i18n":{"zh-CN":{"description":"空响应。"}}}}},{"x-tab-label":"failure","description":"Returns an error message.","x-i18n":{"zh-CN":{"description":"返回错误消息。"}},"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":1800,"message":"User hasn't authenticated"}}}}}}}} +export const endpoint = "/v2/vectordb/databases/alter" +export const method = "post" diff --git a/API_Reference_MDX/milvus-restful/v2.5.x/v2/Database (v2)/alter.mdx b/API_Reference_MDX/milvus-restful/v2.5.x/v2/Database (v2)/alter.mdx deleted file mode 100644 index 154de0175..000000000 --- a/API_Reference_MDX/milvus-restful/v2.5.x/v2/Database (v2)/alter.mdx +++ /dev/null @@ -1,20 +0,0 @@ ---- -displayed_sidebar: restfulSidebar -sidebar_positition: 10 -slug: /restful/alter -title: "Alter | RESTful" -description: "This operation modifies a new database. | RESTful" -hide_table_of_contents: true -sidebar_label: "Alter" -sidebar_custom_props: { badges: ['post']} ---- - -# Alter - -import RestSpecs from '@site/src/components/RestSpecs'; - - - -export const specs = {"summary":"Alter","deprecated":false,"description":"This operation modifies a new database.","x-i18n":{"zh-CN":{"summary":"修改数据库","description":"此操作用于修改指定数据库。"}},"tags":["Database Operations (V2)"],"x-include-target":["milvus"],"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 modify.","x-i18n":{"zh-CN":{"description":"待修改数据库名称。"}}},"properties":{"type":"object","description":"Database properties to modify. For example, you can reset the `mmap.enabled` property to `false` to disable the mmap feature for the collections in the database.","x-i18n":{"zh-CN":{"description":"待修改的数据库属性。例如，可以重新设置 `mmap.enabled` 属性为 `false` 以禁用数据库中 Collection 的 mmap 特性。"}}}},"required":["dbName"]},"example":{"dbName":"test","properties":{"mmap.enabled":true}}}}},"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":"响应码。"}}},"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,"data":{}}},"2":{"summary":"failure","x-target-response":"OPTION 2","value":{"code":0,"message":"The token is illegal."}}}}}}}} -export const endpoint = "/v2/vectordb/databases/alter" -export const method = "post" diff --git a/API_Reference_MDX/milvus-restful/v2.5.x/v2/Database (v2)/create-database.mdx b/API_Reference_MDX/milvus-restful/v2.5.x/v2/Database (v2)/create-database.mdx new file mode 100644 index 000000000..90316b5f5 --- /dev/null +++ b/API_Reference_MDX/milvus-restful/v2.5.x/v2/Database (v2)/create-database.mdx @@ -0,0 +1,28 @@ +--- +displayed_sidebar: restfulSidebar +sidebar_positition: 7 +slug: /restful/create-database +title: "Create Database | RESTful" +description: "This operation creates a new database in the specified cluster. | RESTful" +hide_table_of_contents: true +sidebar_label: "Create Database" +sidebar_custom_props: { badges: ['post']} +keywords: + - zilliz cloud + - zilliz + - cloud + - "Create Database" + - "post" + - RESTful + - API +--- + +# Create Database + +import RestSpecs from '@site/src/components/RestSpecs'; + + + +export const specs = {"summary":"Create Database","deprecated":false,"description":"This operation creates a new database in the specified cluster.","x-i18n":{"zh-CN":{"summary":"创建 Database","description":"在指定集群中创建新的 Database。"}},"tags":["Database 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 new database.","x-i18n":{"zh-CN":{"description":"新 Database 名称。"}}},"properties":{"type":"object","description":"The properties of the new database in key-value pairs.","x-i18n":{"zh-CN":{"description":"以键值对的方式提供的新 Database 的属性。"}},"properties":{"database.replica.number":{"type":"integer","description":"The number of replicas for the new database.","x-i18n":{"zh-CN":{"description":"新 Database 的副本数量。"}}},"database.resource_groups":{"type":"string","description":"The names of the resource groups associated with the new database in a common-separated list.","x-i18n":{"zh-CN":{"description":"与新 Database 关联的资源组名称，以逗号分隔的列表形式提供。"}}},"database.diskQuota.mb":{"type":"integer","description":"The maximum size of the disk space for the new database, in megabytes (MB).","x-i18n":{"zh-CN":{"description":"新 Database 的磁盘空间最大容量，以兆字节 (MB) 为单位。"}}},"database.max.collections":{"type":"integer","description":"The maximum number of collections allowed in the new database.","x-i18n":{"zh-CN":{"description":"新 Database 中允许的最大 Collection 数量。"}}},"database.force.deny.writing":{"type":"boolean","description":"Whether to force the new database to deny writing operations.","x-i18n":{"zh-CN":{"description":"是否强制新 Database 拒绝写入操作。"}}},"database.force.deny.reading":{"type":"boolean","description":"Whether to force the new database to deny reading operations.","x-i18n":{"zh-CN":{"description":"是否强制新 Database 拒绝读取操作。"}}}}}},"required":["dbName"]},"example":{"dbName":"my_database","properties":{"database.replica.number":3}}}}},"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":"响应码。"}}},"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":"返回错误消息。"}},"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":1800,"message":"User hasn't authenticated"}}}}}}}} +export const endpoint = "/v2/vectordb/databases/create" +export const method = "post" diff --git a/API_Reference_MDX/milvus-restful/v2.5.x/v2/Database (v2)/create.mdx b/API_Reference_MDX/milvus-restful/v2.5.x/v2/Database (v2)/create.mdx deleted file mode 100644 index ee002776f..000000000 --- a/API_Reference_MDX/milvus-restful/v2.5.x/v2/Database (v2)/create.mdx +++ /dev/null @@ -1,20 +0,0 @@ ---- -displayed_sidebar: restfulSidebar -sidebar_positition: 7 -slug: /restful/create -title: "Create | RESTful" -description: "This operation creates a new database. | RESTful" -hide_table_of_contents: true -sidebar_label: "Create" -sidebar_custom_props: { badges: ['post']} ---- - -# Create - -import RestSpecs from '@site/src/components/RestSpecs'; - - - -export const specs = {"summary":"Create","deprecated":false,"description":"This operation creates a new database.","x-i18n":{"zh-CN":{"summary":"创建数据库","description":"此操作用于创建新的数据库。"}},"tags":["Database Operations (V2)"],"x-include-target":["milvus"],"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 new database.","x-i18n":{"zh-CN":{"description":"新数据库名称。"}}},"properties":{"type":"object","description":"Additional properties for the new database. For example, you can set the `mmap.enabled` property to `true` to enable the mmap feature for the collections in the database.","x-i18n":{"zh-CN":{"description":"新数据库的附加属性。例如，可以设置 `mmap.enabled` 属性为 `true` 以启用数据库中 Collection 的 mmap 特性。"}}}},"required":["dbName"]},"example":{"dbName":"test","properties":{"mmap.enabled":true}}}}},"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":"响应码。"}}},"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,"data":{}}},"2":{"summary":"failure","x-target-response":"OPTION 2","value":{"code":0,"message":"The token is illegal."}}}}}}}} -export const endpoint = "/v2/vectordb/databases/create" -export const method = "post" diff --git a/API_Reference_MDX/milvus-restful/v2.5.x/v2/Database (v2)/describe-database.mdx b/API_Reference_MDX/milvus-restful/v2.5.x/v2/Database (v2)/describe-database.mdx new file mode 100644 index 000000000..afe3c291b --- /dev/null +++ b/API_Reference_MDX/milvus-restful/v2.5.x/v2/Database (v2)/describe-database.mdx @@ -0,0 +1,28 @@ +--- +displayed_sidebar: restfulSidebar +sidebar_positition: 9 +slug: /restful/describe-database +title: "Describe Database | RESTful" +description: "This operation describes the specified database. | RESTful" +hide_table_of_contents: true +sidebar_label: "Describe Database" +sidebar_custom_props: { badges: ['post']} +keywords: + - zilliz cloud + - zilliz + - cloud + - "Describe Database" + - "post" + - RESTful + - API +--- + +# Describe Database + +import RestSpecs from '@site/src/components/RestSpecs'; + + + +export const specs = {"summary":"Describe Database","deprecated":false,"description":"This operation describes the specified database.","x-i18n":{"zh-CN":{"summary":"查看 Database 详情","description":"本操作查看指定 Database 的详细信息。"}},"tags":["Database 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":"目标 Database 名称。"}}}},"required":["dbName"]},"example":{"dbName":"my_database"}}}},"responses":{"200":{"description":"Returns the properties of the specified database.","x-i18n":{"zh-CN":{"description":"返回指定 Database 的属性。"}},"content":{"application/json":{"schema":{"oneOf":[{"x-tab-label":"success","type":"object","properties":{"code":{"type":"integer","description":"Response code.","x-i18n":{"zh-CN":{"description":"响应码。"}}},"data":{"type":"object","description":"The properties of the specified database in key-value pairs.","x-i18n":{"zh-CN":{"description":"以键值对的方式提供的指定 Database 的属性。"}},"properties":{"database.replica.number":{"type":"integer","description":"The number of replicas for the specified database.","x-i18n":{"zh-CN":{"description":"指定 Database 的副本数量。"}}},"database.resource_groups":{"type":"string","description":"The names of the resource groups associated with the specified database in a common-separated list.","x-i18n":{"zh-CN":{"description":"与指定 Database 关联的资源组名称，以逗号分隔的列表形式提供。"}}},"database.diskQuota.mb":{"type":"integer","description":"The maximum size of the disk space for the specified database, in megabytes (MB).","x-i18n":{"zh-CN":{"description":"指定 Database 的磁盘空间最大容量，以兆字节 (MB) 为单位。"}}},"database.max.collections":{"type":"integer","description":"The maximum number of collections allowed in the specified database.","x-i18n":{"zh-CN":{"description":"指定 Database 中允许的最大 Collection 数量。"}}},"database.force.deny.writing":{"type":"boolean","description":"Whether to force the specified database to deny writing operations.","x-i18n":{"zh-CN":{"description":"是否强制指定 Database 拒绝写入操作。"}}},"database.force.deny.reading":{"type":"boolean","description":"Whether to force the specified database to deny reading operations.","x-i18n":{"zh-CN":{"description":"是否强制指定 Database 拒绝读取操作。"}}}}}}},{"x-tab-label":"failure","description":"Returns an error message.","x-i18n":{"zh-CN":{"description":"返回错误消息。"}},"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":1800,"message":"User hasn't authenticated"}}}}}}}} +export const endpoint = "/v2/vectordb/databases/describe" +export const method = "post" diff --git a/API_Reference_MDX/milvus-restful/v2.5.x/v2/Database (v2)/describe.mdx b/API_Reference_MDX/milvus-restful/v2.5.x/v2/Database (v2)/describe.mdx deleted file mode 100644 index 5da35b4ea..000000000 --- a/API_Reference_MDX/milvus-restful/v2.5.x/v2/Database (v2)/describe.mdx +++ /dev/null @@ -1,20 +0,0 @@ ---- -displayed_sidebar: restfulSidebar -sidebar_positition: 9 -slug: /restful/describe -title: "Describe | RESTful" -description: "This operation lists the details of a database. | RESTful" -hide_table_of_contents: true -sidebar_label: "Describe" -sidebar_custom_props: { badges: ['post']} ---- - -# Describe - -import RestSpecs from '@site/src/components/RestSpecs'; - - - -export const specs = {"summary":"Describe","deprecated":false,"description":"This operation lists the details of a database.","x-i18n":{"zh-CN":{"summary":"查看数据库详情","description":"此操作用于查看指定数据库的具体信息。"}},"tags":["Database Operations (V2)"],"x-include-target":["milvus"],"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. If left unspecified, the default database applies","x-i18n":{"zh-CN":{"description":"目标数据库名称。如果不指定，则使用默认数据库。"}}}}},"example":{"dbName":"default"}}}},"responses":{"200":{"description":"Returns the detailed inforamtion of a database.","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":"响应码。"}}},"data":{"type":"object","description":"Response payload which is the details of a database.","x-i18n":{"zh-CN":{"description":"响应载荷，为数据库的详细信息。"}},"properties":{"dbID":{"type":"number","description":"The ID of the database.","x-i18n":{"zh-CN":{"description":"数据库 ID。"}}},"dbName":{"type":"string","description":"The name of the database.","x-i18n":{"zh-CN":{"description":"数据库名称。"}}},"properties":{"type":"object","description":"Additional properties of the database.","x-i18n":{"zh-CN":{"description":"数据库的附加属性。"}},"properties":{"key":{"type":"string","description":"The key of the property.","x-i18n":{"zh-CN":{"description":"属性键。"}}},"value":{"type":"string","description":"The value of the property.","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":["default","test"]}},"2":{"summary":"failure","x-target-response":"OPTION 2","value":{"code":0,"message":"The token is illegal."}}}}}}}} -export const endpoint = "/v2/vectordb/databases/describe" -export const method = "post" diff --git a/API_Reference_MDX/milvus-restful/v2.5.x/v2/Database (v2)/drop-database-properties.mdx b/API_Reference_MDX/milvus-restful/v2.5.x/v2/Database (v2)/drop-database-properties.mdx new file mode 100644 index 000000000..667ed6f3e --- /dev/null +++ b/API_Reference_MDX/milvus-restful/v2.5.x/v2/Database (v2)/drop-database-properties.mdx @@ -0,0 +1,28 @@ +--- +displayed_sidebar: restfulSidebar +sidebar_positition: 11 +slug: /restful/drop-database-properties +title: "Drop Database Properties | RESTful" +description: "This operation drops the specified properties of the specified database. | RESTful" +hide_table_of_contents: true +sidebar_label: "Drop Database Properties" +sidebar_custom_props: { badges: ['post']} +keywords: + - zilliz cloud + - zilliz + - cloud + - "Drop Database Properties" + - "post" + - RESTful + - API +--- + +# Drop Database Properties + +import RestSpecs from '@site/src/components/RestSpecs'; + + + +export const specs = {"summary":"Drop Database Properties","deprecated":false,"description":"This operation drops the specified properties of the specified database.","x-i18n":{"zh-CN":{"summary":"删除 Database 属性","description":"本操作删除指定 Database 的指定属性。"}},"tags":["Database 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":"目标 Database 名称。"}}},"propertyKeys":{"type":"array","description":"The names of the properties to be dropped.","x-i18n":{"zh-CN":{"description":"要删除的属性名称列表。"}},"items":{"type":"string","description":"The name of a property to be dropped.","x-i18n":{"zh-CN":{"description":"要删除的属性名称。"}},"enum":["database.replica.number","database.resource_groups","database.diskQuota.mb","database.max.collections","database.force.deny.writing","database.force.deny.reading"]}}},"required":["dbName","propertyKeys"]},"example":{"dbName":"my_database","propertyKeys":["database.replica.number"]}}}},"responses":{"200":{"description":"Return an empty response.","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":"响应码。"}}},"data":{"type":"object","description":"An empty response.","x-i18n":{"zh-CN":{"description":"空响应。"}}}}},{"x-tab-label":"failure","description":"Returns an error message.","x-i18n":{"zh-CN":{"description":"返回错误消息。"}},"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":1800,"message":"User hasn't authenticated"}}}}}}}} +export const endpoint = "/v2/vectordb/databases/drop_properties" +export const method = "post" diff --git a/API_Reference_MDX/milvus-restful/v2.5.x/v2/Database (v2)/drop-database.mdx b/API_Reference_MDX/milvus-restful/v2.5.x/v2/Database (v2)/drop-database.mdx new file mode 100644 index 000000000..e09d4f288 --- /dev/null +++ b/API_Reference_MDX/milvus-restful/v2.5.x/v2/Database (v2)/drop-database.mdx @@ -0,0 +1,28 @@ +--- +displayed_sidebar: restfulSidebar +sidebar_positition: 12 +slug: /restful/drop-database +title: "Drop Database | RESTful" +description: "This operation drops the specified database. | RESTful" +hide_table_of_contents: true +sidebar_label: "Drop Database" +sidebar_custom_props: { badges: ['post']} +keywords: + - zilliz cloud + - zilliz + - cloud + - "Drop Database" + - "post" + - RESTful + - API +--- + +# Drop Database + +import RestSpecs from '@site/src/components/RestSpecs'; + + + +export const specs = {"summary":"Drop Database","deprecated":false,"description":"This operation drops the specified database.","x-i18n":{"zh-CN":{"summary":"删除 Database","description":"本操作删除指定 Database。"}},"tags":["Database 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":"目标 Database 名称。"}}}},"required":["dbName"]},"example":{"dbName":"my_database"}}}},"responses":{"200":{"description":"Returns an empty response.","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":"响应码。"}}},"data":{"type":"object","description":"An empty response.","x-i18n":{"zh-CN":{"description":"空响应。"}}}}},{"x-tab-label":"failure","description":"Returns an error message.","x-i18n":{"zh-CN":{"description":"返回错误消息。"}},"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":1800,"message":"User hasn't authenticated"}}}}}}}} +export const endpoint = "/v2/vectordb/databases/drop" +export const method = "post" diff --git a/API_Reference_MDX/milvus-restful/v2.5.x/v2/Database (v2)/drop.mdx b/API_Reference_MDX/milvus-restful/v2.5.x/v2/Database (v2)/drop.mdx deleted file mode 100644 index 51f9a9714..000000000 --- a/API_Reference_MDX/milvus-restful/v2.5.x/v2/Database (v2)/drop.mdx +++ /dev/null @@ -1,20 +0,0 @@ ---- -displayed_sidebar: restfulSidebar -sidebar_positition: 11 -slug: /restful/drop -title: "Drop | RESTful" -description: "This operation drops a database. | RESTful" -hide_table_of_contents: true -sidebar_label: "Drop" -sidebar_custom_props: { badges: ['post']} ---- - -# Drop - -import RestSpecs from '@site/src/components/RestSpecs'; - - - -export const specs = {"summary":"Drop","deprecated":false,"description":"This operation drops a database.","x-i18n":{"zh-CN":{"summary":"删除数据库","description":"此操作用于删除指定的数据库。"}},"tags":["Database Operations (V2)"],"x-include-target":["milvus"],"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 new database. If left unspecified, an error will occur.","x-i18n":{"zh-CN":{"description":"待删除数据库名称。如果不指定，则会报错。"}}}}},"example":{"dbName":"test"}}}},"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":"响应码。"}}},"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,"data":{}}},"2":{"summary":"failure","x-target-response":"OPTION 2","value":{"code":0,"message":"The token is illegal."}}}}}}}} -export const endpoint = "/v2/vectordb/databases/drop" -export const method = "post" diff --git a/API_Reference_MDX/milvus-restful/v2.5.x/v2/Database (v2)/list-databases.mdx b/API_Reference_MDX/milvus-restful/v2.5.x/v2/Database (v2)/list-databases.mdx new file mode 100644 index 000000000..7d3b61398 --- /dev/null +++ b/API_Reference_MDX/milvus-restful/v2.5.x/v2/Database (v2)/list-databases.mdx @@ -0,0 +1,28 @@ +--- +displayed_sidebar: restfulSidebar +sidebar_positition: 8 +slug: /restful/list-databases +title: "List Databases | RESTful" +description: "This operation lists all databases in the current Milvus instance. | RESTful" +hide_table_of_contents: true +sidebar_label: "List Databases" +sidebar_custom_props: { badges: ['post']} +keywords: + - zilliz cloud + - zilliz + - cloud + - "List Databases" + - "post" + - RESTful + - API +--- + +# List Databases + +import RestSpecs from '@site/src/components/RestSpecs'; + + + +export const specs = {"summary":"List Databases","deprecated":false,"description":"This operation lists all databases in the current Milvus instancecluster.","x-i18n":{"zh-CN":{"summary":"查看 Database 列表","description":"本操作列出当前 Milvus 实例集群中的所有 Database。"}},"tags":["Database 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":{}},"example":{}}}},"responses":{"200":{"description":"Returns a list of database names.","x-i18n":{"zh-CN":{"description":"返回 Database 名称列表。"}},"content":{"application/json":{"schema":{"oneOf":[{"x-tab-label":"success","type":"object","properties":{"code":{"type":"integer","description":"Response code.","x-i18n":{"zh-CN":{"description":"响应码。"}}},"data":{"type":"array","items":{"type":"string"},"description":"A list of database names.","x-i18n":{"zh-CN":{"description":"Database 名称列表。"}}}}},{"x-tab-label":"failure","description":"Returns an error message.","x-i18n":{"zh-CN":{"description":"返回错误消息。"}},"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":["default","test"]}},"2":{"summary":"failure","x-target-response":"OPTION 2","value":{"code":1800,"message":"User hasn't authenticated"}}}}}}}} +export const endpoint = "/v2/vectordb/databases/list" +export const method = "post" diff --git a/API_Reference_MDX/milvus-restful/v2.5.x/v2/Database (v2)/list.mdx b/API_Reference_MDX/milvus-restful/v2.5.x/v2/Database (v2)/list.mdx deleted file mode 100644 index fe169f3cd..000000000 --- a/API_Reference_MDX/milvus-restful/v2.5.x/v2/Database (v2)/list.mdx +++ /dev/null @@ -1,20 +0,0 @@ ---- -displayed_sidebar: restfulSidebar -sidebar_positition: 8 -slug: /restful/list -title: "List | RESTful" -description: "This operation lists all databases in the system. | RESTful" -hide_table_of_contents: true -sidebar_label: "List" -sidebar_custom_props: { badges: ['post']} ---- - -# List - -import RestSpecs from '@site/src/components/RestSpecs'; - - - -export const specs = {"summary":"List","deprecated":false,"description":"This operation lists all databases in the system.","x-i18n":{"zh-CN":{"summary":"查看数据库列表","description":"此操作用于列出系统中的所有数据库。"}},"tags":["Database Operations (V2)"],"x-include-target":["milvus"],"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":{}},"example":{}}}},"responses":{"200":{"description":"Returns a list of database names.","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":"响应码。"}}},"data":{"type":"array","description":"Response payload which is a list of database names","x-i18n":{"zh-CN":{"description":"响应载荷，为数据库名称列表。"}},"items":{"type":"string","description":"The name of a database.","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":["default","test"]}},"2":{"summary":"failure","x-target-response":"OPTION 2","value":{"code":0,"message":"The token is illegal."}}}}}}}} -export const endpoint = "/v2/vectordb/databases/list" -export const method = "post" diff --git a/API_Reference_MDX/milvus-restful/v2.5.x/v2/Import (v2)/Create.mdx b/API_Reference_MDX/milvus-restful/v2.5.x/v2/Import (v2)/Create.mdx index c842b4ec8..4cb42ee39 100644 --- a/API_Reference_MDX/milvus-restful/v2.5.x/v2/Import (v2)/Create.mdx +++ b/API_Reference_MDX/milvus-restful/v2.5.x/v2/Import (v2)/Create.mdx @@ -1,12 +1,20 @@ --- displayed_sidebar: restfulSidebar -sidebar_positition: 23 +sidebar_positition: 29 slug: /restful/Create title: "Create Import Jobs | RESTful" description: "This operation imports the prepared data files to a Milvus instance. To learn how to prepare your data files, read [Prepare Data Import](https://milvus.io/docs/prepare-source-data.md). | RESTful" hide_table_of_contents: true sidebar_label: "Create Import Jobs" sidebar_custom_props: { badges: ['post']} +keywords: + - zilliz cloud + - zilliz + - cloud + - "Create Import Jobs" + - "post" + - RESTful + - API --- # Create Import Jobs @@ -15,6 +23,6 @@ import RestSpecs from '@site/src/components/RestSpecs'; -export const specs = {"summary":"Create Import Jobs","deprecated":false,"description":"This operation imports the prepared data files to a Milvus instanceZilliz Cloud cluster. To learn how to prepare your data files, read [Prepare Data Import](https://milvus.io/docs/prepare-source-data.md)[Prepare Data Import](/docs/prepare-data-import).","x-i18n":{"zh-CN":{"summary":"创建导入任务","description":"本接口可将预处理好的数据文件导入到 Milvus 实例Zilliz Cloud 集群。了解如何准备数据文件，请阅读《准备数据导入》《准备数据导入》。"}},"tags":["Import Operations (V2)"],"parameters":[{"name":"Authorization","in":"header","description":"The authentication token should be an API key with appropriate privileges.","required":true,"example":"Bearer {{TOKEN}}","schema":{"type":"string"},"x-i18n":{"zh-CN":{"description":"认证令牌，应为具备适当权限的 API 密钥。"}}}],"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"dbName":{"type":"string","description":"The name of the database that to which the collection belongs .\nSetting this to a non-existing database results in an error.","x-i18n":{"zh-CN":{"description":"Collection 所属的数据库名称。设置为不存在的数据库将导致错误。"}}},"clusterId":{"type":"string","description":"The ID of the cluster to which the collection belongs.\nSetting this to a non-existing cluster results in an error. You can get the cluster ID by calling the [`/v2/clusters`](/reference/restful/list-clusters-v2) endpoint, or copy the cluster ID from the [Zilliz Cloud console](/docs/on-zilliz-cloud-console).","example":"inxx-xxxxxxxxxxxxxxxx","x-i18n":{"zh-CN":{"description":"Collection 所属的集群 ID。设置为不存在的集群将导致错误。您可以通过调用 [`/v2/clusters`](/reference/restful/list-clusters-v2) 端点获取集群 ID，或从 [Zilliz Cloud 控制台](/docs/on-zilliz-cloud-console) 复制集群 ID。"}},"x-include-target":["zilliz"]},"collectionName":{"type":"string","description":"The name of the target collection.\nSetting this to a non-existing collection results in an error.","x-i18n":{"zh-CN":{"description":"目标 Collection 的名称。设置为不存在的 Collection 将导致错误。"}}},"partitionName":{"type":"string","description":"The name of the target partition.\nSetting this to a non-existing partition results in an error.","x-i18n":{"zh-CN":{"description":"目标 Partition 的名称。设置为不存在的 Partition 将导致错误。"}}},"files":{"type":"array","items":{"type":"array","items":{"type":"string","description":"A list of file paths, relative to the root of your Milvus bucket on the MinIO instance shipped along with the Milvus instance.","x-i18n":{"zh-CN":{"description":"文件路径列表，列表中的路径均需位于 MinIO 实例上 Milvus 附带的 Milvus 根目录。"}}},"description":"A sub-list that contains a single JSON or Parquet file, or a set of NumPy files.","x-i18n":{"zh-CN":{"description":"包含单个 JSON 文件, Parquet 文件或一组 NumPy 文件的子列表。"}}},"description":"The files that contain the data to import. The files should reside within the Milvus bucket on the MinIO instance deployed along with your Milvus instance.","x-i18n":{"zh-CN":{"description":"包含待导入数据的文件。这些文件均应位于 MinIO 实例上 Milvus 部署的 Milvus 根目录下。"}},"x-include-target":["milvus"]},"options":{"type":"object","properties":{"timeout":{"type":"string","description":"The timeout duration of the created import jobs. The value should be a positive number suffixed by __s__ (seconds), __m__ (minutes), and __h__(hours). For example, _300s_, _1.5h_, and _1h45_ are all valid values.","x-i18n":{"zh-CN":{"description":"创建导入任务的超时时长。该值应为一个以秒、分钟或小时为单位的正数。例如，300s、1.5h、1h45 都是有效值。"}}}},"description":"Bulk-import options.","x-i18n":{"zh-CN":{"description":"批量导入任务选项设置。"}},"x-include-target":["milvus"]},"objectUrl":{"type":"string","description":"The URL of the object to import. This URL should be accessible to the S3-compatible object storage service, such as AWS S3, GCS, Azure blob storage.","x-i18n":{"zh-CN":{"description":"待导入数据的 URL。该 URL 应来自与诸如阿里云 OSS 或腾讯云 COS 等与 MinIO S3 兼容的对象存储服务。"}},"x-include-target":["zilliz"]},"accessKey":{"type":"string","description":"The access key of the object storage service.","x-i18n":{"zh-CN":{"description":"对象存储服务的访问密钥 (AK)。"}},"x-include-target":["zilliz"]},"secretKey":{"type":"string","description":"The secret access key of the object storage service.","x-i18n":{"zh-CN":{"description":"对象存储服务的访问密钥 (SK)。"}},"x-include-target":["zilliz"]},"token":{"type":"string","description":"A temporary token for you to access the object storage service. The token name and the way to obtain it may vary with cloud providers. For details, refer to [the FAQ](/docs/faq-data-import#can-i-use-session-tokens-when-importing-data-from-an-object-storage-service).","x-include-target":["zilliz"]}},"required":["clusterId","collectionName","objectUrl"]},"examples":{"1":{"summary":"example","x-include-target":["milvus"],"value":{"files":[["/d1782fa1-6b65-4ff3-b05a-43a436342445/1.json"],["/2a12dea7-2eff-4b34-97b6-9554063fd791/1/id.npy","/2a12dea7-2eff-4b34-97b6-9554063fd791/1/vector.npy","/2a12dea7-2eff-4b34-97b6-9554063fd791/1/$meta.npy"],["/a6fb2d1c-7b1b-427c-a8a3-178944e3b66d/1.parquet"]],"collectionName":"quick_setup"}},"2":{"summary":"example","x-include-target":["zilliz"],"value":{"clusterId":"inxx-xxxxxxxxxxxxxxx","collectionName":"medium_articles","partitionName":"","objectUrl":"https://s3.us-west-2.amazonaws.com/publicdataset.zillizcloud.com/medium_articles_2020_dpr/medium_articles_2020_dpr.json","accessKey":"","secretKey":""}}}}}},"responses":{"200":{"description":"The ID of the bulk-import job.","x-i18n":{"zh-CN":{"description":"批量导入任务的 ID。"}},"content":{"application/json":{"schema":{"anyOf":[{"x-tab-label":"success","type":"object","properties":{"code":{"description":"Response code.","x-i18n":{"zh-CN":{"description":"响应码。"}},"type":"integer","example":0},"data":{"type":"array","description":"Response payload which carries the IDs of the created bulk-import jobs.","x-i18n":{"zh-CN":{"description":"响应负载，包含了当前操作创建的批量导入任务的 ID。"}},"items":{"type":"object","description":"A created bulk-import job.","x-i18n":{"zh-CN":{"description":"一个已创建的批量导入任务。"}},"properties":{"jobId":{"type":"string","description":"The ID of the current bulk-import job.","x-i18n":{"zh-CN":{"description":"当前创建的批量导入任务 ID。"}}}}}}}},{"x-tab-label":"failure","description":"Returns an error message.","x-i18n":{"zh-CN":{"description":"返回错误消息。"}},"x-i18n-langs":["zh-CN"],"type":"object","properties":{"code":{"type":"integer","description":"Response code.","x-i18n":{"zh-CN":{"description":"响应码。"}}},"message":{"type":"string","description":"Error message.","x-i18n":{"zh-CN":{"description":"错误描述。"}}}}}]},"examples":{"1":{"summary":"success","x-target-response":"OPTION 1","value":{"code":0,"data":{"jobId":"job-xxxxxxxxxxxxxxxxxxxxx"}}},"2":{"summary":"failure","x-target-response":"OPTION 1","x-include-target":["milvus"],"value":{"code":0,"message":"The token is illegal."}},"3":{"summary":"failure","x-target-response":"OPTION 2","x-include-target":["zilliz"],"value":{"code":21119,"message":"The apikey is illegal."}}}}}}},"security":[]} +export const specs = {"summary":"Create Import Jobs","deprecated":false,"description":"This operation imports the prepared data files to a Milvus instanceZilliz Cloud cluster. To learn how to prepare your data files, read [Prepare Data Import](https://milvus.io/docs/prepare-source-data.md)[Prepare Data Import](/docs/prepare-data-import).","x-i18n":{"zh-CN":{"summary":"创建导入任务","description":"本接口可将预处理好的数据文件导入到 Milvus 实例Zilliz Cloud 集群。了解如何准备数据文件，请阅读《准备数据导入》《准备数据导入》。"}},"tags":["Import Operations (V2)"],"parameters":[{"name":"Authorization","in":"header","description":"The authentication token should be an API key with appropriate privileges.","required":true,"example":"Bearer {{TOKEN}}","schema":{"type":"string"},"x-i18n":{"zh-CN":{"description":"认证令牌，应为具备适当权限的 API 密钥。"}}}],"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"dbName":{"type":"string","description":"The name of the database that to which the collection belongs .\nSetting this to a non-existing database results in an error.","x-i18n":{"zh-CN":{"description":"Collection 所属的数据库名称。设置为不存在的数据库将导致错误。"}}},"clusterId":{"type":"string","description":"The ID of the cluster to which the collection belongs.\nSetting this to a non-existing cluster results in an error. You can get the cluster ID by calling the [`/v2/clusters`](/reference/restful/list-clusters-v2) endpoint, or copy the cluster ID from the [Zilliz Cloud console](/docs/on-zilliz-cloud-console).","example":"inxx-xxxxxxxxxxxxxxxx","x-i18n":{"zh-CN":{"description":"Collection 所属的集群 ID。设置为不存在的集群将导致错误。您可以通过调用 [`/v2/clusters`](/reference/restful/list-clusters-v2) 端点获取集群 ID，或从 [Zilliz Cloud 控制台](/docs/on-zilliz-cloud-console) 复制集群 ID。"}},"x-include-target":["zilliz"]},"collectionName":{"type":"string","description":"The name of the target collection.\nSetting this to a non-existing collection results in an error.","x-i18n":{"zh-CN":{"description":"目标 Collection 的名称。设置为不存在的 Collection 将导致错误。"}}},"partitionName":{"type":"string","description":"The name of the target partition.\nSetting this to a non-existing partition results in an error.","x-i18n":{"zh-CN":{"description":"目标 Partition 的名称。设置为不存在的 Partition 将导致错误。"}}},"files":{"type":"array","items":{"type":"array","items":{"type":"string","description":"A list of file paths, relative to the root of your Milvus bucket on the MinIO instance shipped along with the Milvus instance.","x-i18n":{"zh-CN":{"description":"文件路径列表，列表中的路径均需位于 MinIO 实例上 Milvus 附带的 Milvus 根目录。"}}},"description":"A sub-list that contains a single JSON or Parquet file, or a set of NumPy files.","x-i18n":{"zh-CN":{"description":"包含单个 JSON 文件, Parquet 文件或一组 NumPy 文件的子列表。"}}},"description":"The files that contain the data to import. The files should reside within the Milvus bucket on the MinIO instance deployed along with your Milvus instance.","x-i18n":{"zh-CN":{"description":"包含待导入数据的文件。这些文件均应位于 MinIO 实例上 Milvus 部署的 Milvus 根目录下。"}},"x-include-target":["milvus"]},"options":{"type":"object","properties":{"timeout":{"type":"string","description":"The timeout duration of the created import jobs. The value should be a positive number suffixed by __s__ (seconds), __m__ (minutes), and __h__(hours). For example, _300s_, _1.5h_, and _1h45_ are all valid values.","x-i18n":{"zh-CN":{"description":"创建导入任务的超时时长。该值应为一个以秒、分钟或小时为单位的正数。例如，300s、1.5h、1h45 都是有效值。"}}}},"description":"Bulk-import options.","x-i18n":{"zh-CN":{"description":"批量导入任务选项设置。"}},"x-include-target":["milvus"]},"objectUrl":{"type":"string","description":"The URL of the object to import. This URL should be accessible to the S3-compatible object storage service, such as AWS S3, GCS, Azure blob storage.","x-i18n":{"zh-CN":{"description":"待导入数据的 URL。该 URL 应来自与诸如阿里云 OSS 或腾讯云 COS 等与 MinIO S3 兼容的对象存储服务。"}},"x-include-target":["zilliz"]},"accessKey":{"type":"string","description":"The access key of the object storage service.","x-i18n":{"zh-CN":{"description":"对象存储服务的访问密钥 (AK)。"}},"x-include-target":["zilliz"]},"secretKey":{"type":"string","description":"The secret access key of the object storage service.","x-i18n":{"zh-CN":{"description":"对象存储服务的访问密钥 (SK)。"}},"x-include-target":["zilliz"]},"token":{"type":"string","description":"A temporary token for you to access the object storage service. The token name and the way to obtain it may vary with cloud providers. For details, refer to [the FAQ](/docs/faq-data-import#can-i-use-session-tokens-when-importing-data-from-an-object-storage-service).","x-include-target":["zilliz"]}},"required":["clusterId","collectionName","objectUrl"]},"examples":{"1":{"summary":"example","x-include-target":["milvus"],"value":{"files":[["/d1782fa1-6b65-4ff3-b05a-43a436342445/1.json"],["/2a12dea7-2eff-4b34-97b6-9554063fd791/1/id.npy","/2a12dea7-2eff-4b34-97b6-9554063fd791/1/vector.npy","/2a12dea7-2eff-4b34-97b6-9554063fd791/1/$meta.npy"],["/a6fb2d1c-7b1b-427c-a8a3-178944e3b66d/1.parquet"]],"collectionName":"quick_setup"}},"2":{"summary":"example","x-include-target":["zilliz"],"value":{"clusterId":"inxx-xxxxxxxxxxxxxxx","collectionName":"medium_articles","partitionName":"","objectUrl":"https://s3.us-west-2.amazonaws.com/publicdataset.zillizcloud.com/medium_articles_2020_dpr/medium_articles_2020_dpr.json","accessKey":"","secretKey":""}}}}}},"responses":{"200":{"description":"The ID of the bulk-import job.","x-i18n":{"zh-CN":{"description":"批量导入任务的 ID。"}},"content":{"application/json":{"schema":{"anyOf":[{"x-tab-label":"success","type":"object","properties":{"code":{"description":"Response code.","x-i18n":{"zh-CN":{"description":"响应码。"}},"type":"integer","example":0},"data":{"type":"array","description":"Response payload which carries the IDs of the created bulk-import jobs.","x-i18n":{"zh-CN":{"description":"响应负载，包含了当前操作创建的批量导入任务的 ID。"}},"items":{"type":"object","description":"A created bulk-import job.","x-i18n":{"zh-CN":{"description":"一个已创建的批量导入任务。"}},"properties":{"jobId":{"type":"string","description":"The ID of the current bulk-import job.","x-i18n":{"zh-CN":{"description":"当前创建的批量导入任务 ID。"}}}}}}}},{"x-tab-label":"failure","description":"Returns an error message.","x-i18n":{"zh-CN":{"description":"返回错误消息。"}},"x-i18n-langs":["zh-CN"],"type":"object","properties":{"code":{"type":"integer","description":"Response code.","x-i18n":{"zh-CN":{"description":"响应码。"}}},"message":{"type":"string","description":"Error message.","x-i18n":{"zh-CN":{"description":"错误描述。"}}}}}]},"examples":{"1":{"summary":"success","x-target-response":"OPTION 1","value":{"code":0,"data":{"jobId":"job-xxxxxxxxxxxxxxxxxxxxx"}}},"2":{"summary":"failure","x-target-response":"OPTION 1","x-include-target":["milvus"],"value":{"code":1800,"message":"User hasn't authenticated"}},"3":{"summary":"failure","x-target-response":"OPTION 2","x-include-target":["zilliz"],"value":{"code":21119,"message":"The apikey is illegal."}}}}}}},"security":[]} export const endpoint = "/v2/vectordb/jobs/import/create" export const method = "post" diff --git a/API_Reference_MDX/milvus-restful/v2.5.x/v2/Import (v2)/Get Progress.mdx b/API_Reference_MDX/milvus-restful/v2.5.x/v2/Import (v2)/Get Progress.mdx index dafbaa7fd..668b05f88 100644 --- a/API_Reference_MDX/milvus-restful/v2.5.x/v2/Import (v2)/Get Progress.mdx +++ b/API_Reference_MDX/milvus-restful/v2.5.x/v2/Import (v2)/Get Progress.mdx @@ -1,12 +1,20 @@ --- displayed_sidebar: restfulSidebar -sidebar_positition: 53 +sidebar_positition: 63 slug: /restful/Get Progress title: "Get Import Job Progress | RESTful" description: "This operation gets the progress of the specified bulk-import job. | RESTful" hide_table_of_contents: true sidebar_label: "Get Import Job Progress" sidebar_custom_props: { badges: ['post']} +keywords: + - zilliz cloud + - zilliz + - cloud + - "Get Import Job Progress" + - "post" + - RESTful + - API --- # Get Import Job Progress @@ -15,6 +23,6 @@ import RestSpecs from '@site/src/components/RestSpecs'; -export const specs = {"summary":"Get Import Job Progress","deprecated":false,"description":"This operation gets the progress of the specified bulk-import job.","x-i18n":{"zh-CN":{"summary":"获取导入任务进度","description":"本接口可获取指定导入任务的进度信息。"}},"x-include-target":["milvus"],"tags":["Import Operations (V2)"],"parameters":[{"name":"Authorization","in":"header","description":"The authentication token should be an API key with appropriate privileges or a pair of colon-joined username and password, like `username:password`.","required":true,"example":"Bearer {{TOKEN}}","schema":{"type":"string"},"x-i18n":{"zh-CN":{"description":"认证令牌，应为具备适当权限的 API 密钥或用冒号分隔的用户名和密码，如 `username:password`。"}}}],"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"clusterId":{"type":"string","description":"The ID of a cluster to which this operation applies.","x-i18n":{"zh-CN":{"description":"指定集群 ID。"}},"x-include-target":["zilliz"]},"dbName":{"type":"string","description":"The name of the target database of this operation.","default":"default","x-i18n":{"zh-CN":{"description":"当前操作的目标数据库名称。"}}},"jobId":{"type":"string","description":"The ID of the bulk-import job of your interest. \nThe [Create Import Jobs](/reference/restful/create-import-jobs-v2) operation usually returns a job ID. You can also call [List Import Jobs](/reference/restful/list-import-jobs-v2) to get the IDs of all bulk-import jobs related to the specific cluster.","x-i18n":{"zh-CN":{"description":"需要查询的导入任务 ID。\n[创建导入任务](/reference/restful/create-import-jobs-v2)操作通常会返回一个任务 ID。您也可以调用[列出导入任务](/reference/restful/list-import-jobs-v2)获取特定集群相关的所有导入任务的 ID。"}}}},"required":["jobId"]},"example":{"jobId":"job-xxxxxxxxxxxxxxxx"}}}},"responses":{"200":{"description":"成功","content":{"application/json":{"schema":{"anyOf":[{"x-tab-label":"success","type":"object","properties":{"code":{"description":"Response code.","x-i18n":{"zh-CN":{"description":"响应码。"}},"type":"integer","example":0},"data":{"type":"object","description":"Response payload which contains the progress of the specified bulk-import job in detail.","x-i18n":{"zh-CN":{"description":"响应负载，为包含指定导入任务进度信息在内的详细信息。"}},"properties":{"collectionName":{"type":"string","description":"The name of the target collection of this bulk-import job.","x-i18n":{"zh-CN":{"description":"当前导入任务的目标 Collection 名称。"}}},"completeTime":{"type":"string","description":"The timestamp indicating when the bulk-import job is complete.","x-i18n":{"zh-CN":{"description":"当前导入任务完成时间。"}}},"details":{"type":"array","items":{"type":"object","properties":{"completeTime":{"type":"string","description":"The timestamp at which the file is processed.","x-i18n":{"zh-CN":{"description":"当前数据文件完成处理时间。"}}},"fileName":{"type":"string","description":"The name of a data file.","x-i18n":{"zh-CN":{"description":"数据文件名称。"}}},"fileSize":{"type":"string","description":"The size of the data file.","x-i18n":{"zh-CN":{"description":"数据文件大小。"}}},"progress":{"type":"string","description":"The progress in percentage.","x-i18n":{"zh-CN":{"description":"进度百分比。"}}},"state":{"type":"string","description":"The processing state of the data file.","x-i18n":{"zh-CN":{"description":"数据文件处理状态。"}},"enum":["Pending","Importing","Completed","Failed"]},"reason":{"type":"string","description":"The reason for the failure to bulk import data. This field stays empty if this job succeeds.","x-i18n":{"zh-CN":{"description":"导入失败原因。如果导入成功，该字段为空。"}}},"importedRows":{"type":"string","description":"The number of rows imported from this file.","x-i18n":{"zh-CN":{"description":"从当前文件导入的行数。"}}},"totalRows":{"type":"string","description":"The number of rows in the specified collection upon the import from this file is complete.","x-i18n":{"zh-CN":{"description":"从当前文件导入数据完成后，目标 Collection 中的总行数。"}}}},"description":"Statistics on data import from a file.","x-i18n":{"zh-CN":{"description":"从某个数据文件中导入数据的统计信息。"}}},"description":"Statistics on data import oriented to data files.","x-i18n":{"zh-CN":{"description":"按数据文件维度分别收集的数据导入统计信息。"}}},"fileSize":{"type":"integer","description":"The uploaded file size in bytes.","x-i18n":{"zh-CN":{"description":"已上传文件大小（字节）。"}}},"jobId":{"type":"integer","description":"The ID of this bulk-import job.","x-i18n":{"zh-CN":{"description":"批量导入任务 ID。"}}},"progress":{"type":"integer","description":"The progress in percentage of the current bulk-import job.","x-i18n":{"zh-CN":{"description":"当前导入任务的进度百分比。"}}},"state":{"type":"string","description":"The state of this bulk-import job.","x-i18n":{"zh-CN":{"description":"当前导入任务的状态。"}},"enum":["Pending","Importing","Completed","Failed"]},"reason":{"type":"string","description":"The reason for the failure to bulk import data. The field value stays empty if this job succeeds.","x-i18n":{"zh-CN":{"description":"当前导入任务失败的原因。任务成功时为空字符串。"}}},"importedRows":{"type":"integer","description":"The number of rows inserted into the specified collection upon this import.","x-i18n":{"zh-CN":{"description":"当前任务完成导入完成后，向目标 Collection 中插入的行数。"}}},"totalRows":{"type":"integer","description":"The number of rows in the specified collection.","x-i18n":{"zh-CN":{"description":"当前导入任务完成后，目标 Collection 中的总行数。"}}}}}}},{"x-tab-label":"failure","description":"Returns an error message.","x-i18n":{"zh-CN":{"description":"返回错误消息。"}},"x-i18n-langs":["zh-CN"],"type":"object","properties":{"code":{"type":"integer","description":"Response code.","x-i18n":{"zh-CN":{"description":"响应码。"}}},"message":{"type":"string","description":"Error message.","x-i18n":{"zh-CN":{"description":"错误描述。"}}}}}]},"examples":{"1":{"summary":"success","x-target-response":"OPTION 1","value":{"code":0,"data":{"jobId":"448761313698322011","collectionName":"medium_articles","fileName":"medium_articles_2020_dpr.json","fileSize":3279917,"state":"Completed","progress":100,"completeTime":"2024-04-01T06:17:55Z","reason":"","totalRows":100000,"details":[{"fileName":"medium_articles_2020_dpr.json","fileSize":3279917,"state":"Completed","progress":100,"completeTime":"2024-04-01T06:17:53Z","reason":""}]}}},"2":{"summary":"failure","x-target-response":"OPTION 2","value":{"code":0,"message":"The token is illegal."}}}}}}},"security":[]} +export const specs = {"summary":"Get Import Job Progress","deprecated":false,"description":"This operation gets the progress of the specified bulk-import job.","x-i18n":{"zh-CN":{"summary":"获取导入任务进度","description":"本接口可获取指定导入任务的进度信息。"}},"x-include-target":["milvus"],"tags":["Import Operations (V2)"],"parameters":[{"name":"Authorization","in":"header","description":"The authentication token should be an API key with appropriate privileges or a pair of colon-joined username and password, like `username:password`.","required":true,"example":"Bearer {{TOKEN}}","schema":{"type":"string"},"x-i18n":{"zh-CN":{"description":"认证令牌，应为具备适当权限的 API 密钥或用冒号分隔的用户名和密码，如 `username:password`。"}}}],"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"clusterId":{"type":"string","description":"The ID of a cluster to which this operation applies.","x-i18n":{"zh-CN":{"description":"指定集群 ID。"}},"x-include-target":["zilliz"]},"dbName":{"type":"string","description":"The name of the target database of this operation.","default":"default","x-i18n":{"zh-CN":{"description":"当前操作的目标数据库名称。"}}},"jobId":{"type":"string","description":"The ID of the bulk-import job of your interest. \nThe [Create Import Jobs](/reference/restful/create-import-jobs-v2) operation usually returns a job ID. You can also call [List Import Jobs](/reference/restful/list-import-jobs-v2) to get the IDs of all bulk-import jobs related to the specific cluster.","x-i18n":{"zh-CN":{"description":"需要查询的导入任务 ID。\n[创建导入任务](/reference/restful/create-import-jobs-v2)操作通常会返回一个任务 ID。您也可以调用[列出导入任务](/reference/restful/list-import-jobs-v2)获取特定集群相关的所有导入任务的 ID。"}}}},"required":["jobId"]},"example":{"jobId":"job-xxxxxxxxxxxxxxxx"}}}},"responses":{"200":{"description":"成功","content":{"application/json":{"schema":{"anyOf":[{"x-tab-label":"success","type":"object","properties":{"code":{"description":"Response code.","x-i18n":{"zh-CN":{"description":"响应码。"}},"type":"integer","example":0},"data":{"type":"object","description":"Response payload which contains the progress of the specified bulk-import job in detail.","x-i18n":{"zh-CN":{"description":"响应负载，为包含指定导入任务进度信息在内的详细信息。"}},"properties":{"collectionName":{"type":"string","description":"The name of the target collection of this bulk-import job.","x-i18n":{"zh-CN":{"description":"当前导入任务的目标 Collection 名称。"}}},"completeTime":{"type":"string","description":"The timestamp indicating when the bulk-import job is complete.","x-i18n":{"zh-CN":{"description":"当前导入任务完成时间。"}}},"details":{"type":"array","items":{"type":"object","properties":{"completeTime":{"type":"string","description":"The timestamp at which the file is processed.","x-i18n":{"zh-CN":{"description":"当前数据文件完成处理时间。"}}},"fileName":{"type":"string","description":"The name of a data file.","x-i18n":{"zh-CN":{"description":"数据文件名称。"}}},"fileSize":{"type":"string","description":"The size of the data file.","x-i18n":{"zh-CN":{"description":"数据文件大小。"}}},"progress":{"type":"string","description":"The progress in percentage.","x-i18n":{"zh-CN":{"description":"进度百分比。"}}},"state":{"type":"string","description":"The processing state of the data file.","x-i18n":{"zh-CN":{"description":"数据文件处理状态。"}},"enum":["Pending","Importing","Completed","Failed"]},"reason":{"type":"string","description":"The reason for the failure to bulk import data. This field stays empty if this job succeeds.","x-i18n":{"zh-CN":{"description":"导入失败原因。如果导入成功，该字段为空。"}}},"importedRows":{"type":"string","description":"The number of rows imported from this file.","x-i18n":{"zh-CN":{"description":"从当前文件导入的行数。"}}},"totalRows":{"type":"string","description":"The number of rows in the specified collection upon the import from this file is complete.","x-i18n":{"zh-CN":{"description":"从当前文件导入数据完成后，目标 Collection 中的总行数。"}}}},"description":"Statistics on data import from a file.","x-i18n":{"zh-CN":{"description":"从某个数据文件中导入数据的统计信息。"}}},"description":"Statistics on data import oriented to data files.","x-i18n":{"zh-CN":{"description":"按数据文件维度分别收集的数据导入统计信息。"}}},"fileSize":{"type":"integer","description":"The uploaded file size in bytes.","x-i18n":{"zh-CN":{"description":"已上传文件大小（字节）。"}}},"jobId":{"type":"integer","description":"The ID of this bulk-import job.","x-i18n":{"zh-CN":{"description":"批量导入任务 ID。"}}},"progress":{"type":"integer","description":"The progress in percentage of the current bulk-import job.","x-i18n":{"zh-CN":{"description":"当前导入任务的进度百分比。"}}},"state":{"type":"string","description":"The state of this bulk-import job.","x-i18n":{"zh-CN":{"description":"当前导入任务的状态。"}},"enum":["Pending","Importing","Completed","Failed"]},"reason":{"type":"string","description":"The reason for the failure to bulk import data. The field value stays empty if this job succeeds.","x-i18n":{"zh-CN":{"description":"当前导入任务失败的原因。任务成功时为空字符串。"}}},"importedRows":{"type":"integer","description":"The number of rows inserted into the specified collection upon this import.","x-i18n":{"zh-CN":{"description":"当前任务完成导入完成后，向目标 Collection 中插入的行数。"}}},"totalRows":{"type":"integer","description":"The number of rows in the specified collection.","x-i18n":{"zh-CN":{"description":"当前导入任务完成后，目标 Collection 中的总行数。"}}}}}}},{"x-tab-label":"failure","description":"Returns an error message.","x-i18n":{"zh-CN":{"description":"返回错误消息。"}},"x-i18n-langs":["zh-CN"],"type":"object","properties":{"code":{"type":"integer","description":"Response code.","x-i18n":{"zh-CN":{"description":"响应码。"}}},"message":{"type":"string","description":"Error message.","x-i18n":{"zh-CN":{"description":"错误描述。"}}}}}]},"examples":{"1":{"summary":"success","x-target-response":"OPTION 1","value":{"code":0,"data":{"jobId":"448761313698322011","collectionName":"medium_articles","fileName":"medium_articles_2020_dpr.json","fileSize":3279917,"state":"Completed","progress":100,"completeTime":"2024-04-01T06:17:55Z","reason":"","totalRows":100000,"details":[{"fileName":"medium_articles_2020_dpr.json","fileSize":3279917,"state":"Completed","progress":100,"completeTime":"2024-04-01T06:17:53Z","reason":""}]}}},"2":{"summary":"failure","x-target-response":"OPTION 2","value":{"code":21119,"message":"The apikey is illegal."}}}}}}},"security":[]} export const endpoint = "/v2/vectordb/jobs/import/describe" export const method = "post" diff --git a/API_Reference_MDX/milvus-restful/v2.5.x/v2/Import (v2)/List.mdx b/API_Reference_MDX/milvus-restful/v2.5.x/v2/Import (v2)/List.mdx index b606a8b4d..bc2f26b26 100644 --- a/API_Reference_MDX/milvus-restful/v2.5.x/v2/Import (v2)/List.mdx +++ b/API_Reference_MDX/milvus-restful/v2.5.x/v2/Import (v2)/List.mdx @@ -1,12 +1,20 @@ --- displayed_sidebar: restfulSidebar -sidebar_positition: 32 +sidebar_positition: 38 slug: /restful/List title: "List Import Jobs | RESTful" description: "This operation lists all import jobs of a specific cluster. | RESTful" hide_table_of_contents: true sidebar_label: "List Import Jobs" sidebar_custom_props: { badges: ['post']} +keywords: + - zilliz cloud + - zilliz + - cloud + - "List Import Jobs" + - "post" + - RESTful + - API --- # List Import Jobs @@ -15,6 +23,6 @@ import RestSpecs from '@site/src/components/RestSpecs'; -export const specs = {"summary":"List Import Jobs","deprecated":false,"description":"This operation lists all import jobs of a specific cluster.","x-i18n":{"zh-CN":{"summary":"查看导入任务列表","description":"本接口可列出当前集群的所有导入任务。"}},"tags":["Import Operations (V2)"],"parameters":[{"name":"Authorization","in":"header","description":"The authentication token should be an API key with appropriate privileges.","required":true,"example":"Bearer {{TOKEN}}","schema":{"type":"string"},"x-i18n":{"zh-CN":{"description":"认证令牌，应为具备适当权限的 API 密钥。"}}},{"name":"Accept","in":"header","description":"Use `application/json`.","x-i18n":{"zh-CN":{"description":"使用 `application/json`。"}},"required":false,"example":"application/json","schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"clusterId":{"type":"string","description":"ID of a specific cluster on Zilliz Cloud.","x-i18n":{"zh-CN":{"description":"Zilliz Cloud 上的特定集群的 ID。"}},"x-include-target":["zilliz"]},"pageSize":{"type":"integer","description":"Number of records to return at each request.","x-i18n":{"zh-CN":{"description":"每次返回的记录数。"}},"x-include-target":["zilliz"]},"currentPage":{"type":"integer","description":"Current page number.","x-i18n":{"zh-CN":{"description":"当前页码。"}},"x-include-target":["zilliz"]},"dbName":{"type":"string","description":"Name of the database to which the import job belongs."}},"required":["clusterId"]},"example":{"clusterId":"inxx-xxxxxxxxxxxxxxx"}}}},"responses":{"200":{"description":"Returns a list of import jobs","x-i18n":{"zh-CN":{"description":"返回导入任务列表。"}},"content":{"application/json":{"schema":{"anyOf":[{"type":"object","properties":{"code":{"type":"string","description":"Response code.","x-i18n":{"zh-CN":{"description":"响应码。"}}},"data":{"type":"object","properties":{"count":{"type":"integer","description":"Total number of records listed in this response.","x-i18n":{"zh-CN":{"description":"本次返回的记录总数。"}},"x-include-target":["zilliz"]},"currentPage":{"type":"integer","description":"Current page number for your reference.","x-i18n":{"zh-CN":{"description":"当前页码。"}},"x-include-target":["zilliz"]},"pageSize":{"type":"integer","description":"Maximum number of records to be included in each return.","x-i18n":{"zh-CN":{"description":"每次返回包含的最大记录数。"}},"x-include-target":["zilliz"]},"records":{"type":"array","items":{"type":"object","properties":{"collectionName":{"type":"string","description":"Name of the target collection of this import job.","x-i18n":{"zh-CN":{"description":"当前导入任务的目标 Collection 名称。"}}},"jobId":{"type":"string","description":"ID of this import job.","x-i18n":{"zh-CN":{"description":"当前导入任务的 ID。"}}},"state":{"type":"string","description":"State of this import job.","x-i18n":{"zh-CN":{"description":"当前导入任务的状态。"}},"enum":["Pending","InProgress","Completed","Failed"]},"progress":{"type":"number","description":"Progress of this import job.","x-i18n":{"zh-CN":{"description":"当前导入任务的进度。"}},"x-include-target":["milvus"]},"reason":{"type":"string","description":"Reason for the failure of this import job.","x-i18n":{"zh-CN":{"description":"当前导入任务失败的原因。"}},"x-include-target":["milvus"]}},"description":"An import job in detail.","x-i18n":{"zh-CN":{"description":"导入任务的详细信息。"}}},"description":"List of import jobs in detail.","x-i18n":{"zh-CN":{"description":"导入任务详情列表。"}}}},"description":"Response payload, which is a list of import jobs in detail.","x-i18n":{"zh-CN":{"description":"响应负载，为导入任务详情列表。"}}}}},{"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","value":{"code":0,"data":{"count":1,"currentPage":1,"pageSize":10,"records":[{"collectionName":"test_collection","jobId":"job-xxxxxxxxxxxxxxxxxxxxx","state":"Completed"}]}}},"2":{"summary":"failure","x-include-target":["milvus"],"value":{"code":"0","message":"The token is illegal."}},"3":{"summary":"failure","x-include-target":["zilliz"],"value":{"code":21119,"message":"The apikey is illegal."}}}}}}},"security":[]} +export const specs = {"summary":"List Import Jobs","deprecated":false,"description":"This operation lists all import jobs of a specific cluster.","x-i18n":{"zh-CN":{"summary":"查看导入任务列表","description":"本接口可列出当前集群的所有导入任务。"}},"tags":["Import Operations (V2)"],"parameters":[{"name":"Authorization","in":"header","description":"The authentication token should be an API key with appropriate privileges.","required":true,"example":"Bearer {{TOKEN}}","schema":{"type":"string"},"x-i18n":{"zh-CN":{"description":"认证令牌，应为具备适当权限的 API 密钥。"}}},{"name":"Accept","in":"header","description":"Use `application/json`.","x-i18n":{"zh-CN":{"description":"使用 `application/json`。"}},"required":false,"example":"application/json","schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"clusterId":{"type":"string","description":"ID of a specific cluster on Zilliz Cloud.","x-i18n":{"zh-CN":{"description":"Zilliz Cloud 上的特定集群的 ID。"}},"x-include-target":["zilliz"]},"pageSize":{"type":"integer","description":"Number of records to return at each request.","x-i18n":{"zh-CN":{"description":"每次返回的记录数。"}},"x-include-target":["zilliz"]},"currentPage":{"type":"integer","description":"Current page number.","x-i18n":{"zh-CN":{"description":"当前页码。"}},"x-include-target":["zilliz"]},"dbName":{"type":"string","description":"Name of the database to which the import job belongs."}},"required":["clusterId"]},"example":{"clusterId":"inxx-xxxxxxxxxxxxxxx"}}}},"responses":{"200":{"description":"Returns a list of import jobs","x-i18n":{"zh-CN":{"description":"返回导入任务列表。"}},"content":{"application/json":{"schema":{"anyOf":[{"type":"object","properties":{"code":{"type":"string","description":"Response code.","x-i18n":{"zh-CN":{"description":"响应码。"}}},"data":{"type":"object","properties":{"count":{"type":"integer","description":"Total number of records listed in this response.","x-i18n":{"zh-CN":{"description":"本次返回的记录总数。"}},"x-include-target":["zilliz"]},"currentPage":{"type":"integer","description":"Current page number for your reference.","x-i18n":{"zh-CN":{"description":"当前页码。"}},"x-include-target":["zilliz"]},"pageSize":{"type":"integer","description":"Maximum number of records to be included in each return.","x-i18n":{"zh-CN":{"description":"每次返回包含的最大记录数。"}},"x-include-target":["zilliz"]},"records":{"type":"array","items":{"type":"object","properties":{"collectionName":{"type":"string","description":"Name of the target collection of this import job.","x-i18n":{"zh-CN":{"description":"当前导入任务的目标 Collection 名称。"}}},"jobId":{"type":"string","description":"ID of this import job.","x-i18n":{"zh-CN":{"description":"当前导入任务的 ID。"}}},"state":{"type":"string","description":"State of this import job.","x-i18n":{"zh-CN":{"description":"当前导入任务的状态。"}},"enum":["Pending","InProgress","Completed","Failed"]},"progress":{"type":"number","description":"Progress of this import job.","x-i18n":{"zh-CN":{"description":"当前导入任务的进度。"}},"x-include-target":["milvus"]},"reason":{"type":"string","description":"Reason for the failure of this import job.","x-i18n":{"zh-CN":{"description":"当前导入任务失败的原因。"}},"x-include-target":["milvus"]}},"description":"An import job in detail.","x-i18n":{"zh-CN":{"description":"导入任务的详细信息。"}}},"description":"List of import jobs in detail.","x-i18n":{"zh-CN":{"description":"导入任务详情列表。"}}}},"description":"Response payload, which is a list of import jobs in detail.","x-i18n":{"zh-CN":{"description":"响应负载，为导入任务详情列表。"}}}}},{"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","value":{"code":0,"data":{"count":1,"currentPage":1,"pageSize":10,"records":[{"collectionName":"test_collection","jobId":"job-xxxxxxxxxxxxxxxxxxxxx","state":"Completed"}]}}},"2":{"summary":"failure","x-include-target":["milvus"],"value":{"code":1800,"message":"User hasn't authenticated"}},"3":{"summary":"failure","x-include-target":["zilliz"],"value":{"code":21119,"message":"The apikey is illegal."}}}}}}},"security":[]} export const endpoint = "/v2/vectordb/jobs/import/list" export const method = "post" diff --git a/API_Reference_MDX/milvus-restful/v2.5.x/v2/Index (v2)/Alter Properties.mdx b/API_Reference_MDX/milvus-restful/v2.5.x/v2/Index (v2)/Alter Properties.mdx new file mode 100644 index 000000000..321b740fa --- /dev/null +++ b/API_Reference_MDX/milvus-restful/v2.5.x/v2/Index (v2)/Alter Properties.mdx @@ -0,0 +1,28 @@ +--- +displayed_sidebar: restfulSidebar +sidebar_positition: 41 +slug: /restful/Alter Properties +title: "Alter Index Properties | RESTful" +description: "This operation alters the properties of an index. | RESTful" +hide_table_of_contents: true +sidebar_label: "Alter Index Properties" +sidebar_custom_props: { badges: ['post']} +keywords: + - zilliz cloud + - zilliz + - cloud + - "Alter Index Properties" + - "post" + - RESTful + - API +--- + +# Alter Index Properties + +import RestSpecs from '@site/src/components/RestSpecs'; + + + +export const specs = {"summary":"Alter Index Properties","deprecated":false,"description":"This operation alters the properties of an index.","x-i18n":{"zh-CN":{"summary":"修改索引属性","description":"本操作修改索引属性。"}},"tags":["Index 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 所属的数据库名称。设置为不存在的数据库将导致错误。"}}},"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 将导致错误。"}}},"indexName":{"type":"string","description":"The name of the target index.","x-i18n":{"zh-CN":{"description":"目标索引的名称。"}}},"properties":{"type":"object","description":"The new index parameters to be set.","x-i18n":{"zh-CN":{"description":"要设置的新索引参数。"}},"properties":{"mmap.enabled":{"type":"boolean","description":"Whether to enable memory mapping for the current index.","x-i18n":{"zh-CN":{"description":"是否为当前索引启用内存映射。"}}}}}},"required":["indexName","collectionName","properties"]},"example":{"collectionName":"test_collection","indexName":"my_vector","properties":{"nlist":1024}}}}},"responses":{"200":{"description":"Returns an empty response.","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":"响应码。"}}},"data":{"type":"object","properties":{}}}},{"x-tab-label":"failure","description":"Returns an error message.","x-i18n":{"zh-CN":{"description":"返回错误消息。"}},"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":1800,"message":"User hasn't authenticated"}}}}}}}} +export const endpoint = "/v2/vectordb/indexes/alter_properties" +export const method = "post" diff --git a/API_Reference_MDX/milvus-restful/v2.5.x/v2/Index (v2)/Create.mdx b/API_Reference_MDX/milvus-restful/v2.5.x/v2/Index (v2)/Create.mdx index b0f3f58aa..7c6b5afe4 100644 --- a/API_Reference_MDX/milvus-restful/v2.5.x/v2/Index (v2)/Create.mdx +++ b/API_Reference_MDX/milvus-restful/v2.5.x/v2/Index (v2)/Create.mdx @@ -1,12 +1,20 @@ --- displayed_sidebar: restfulSidebar -sidebar_positition: 15 +sidebar_positition: 21 slug: /restful/Create title: "Create Index | RESTful" description: "This creates a named index for a target field, which can either be a vector field or a scalar field. | RESTful" hide_table_of_contents: true sidebar_label: "Create Index" sidebar_custom_props: { badges: ['post']} +keywords: + - zilliz cloud + - zilliz + - cloud + - "Create Index" + - "post" + - RESTful + - API --- # Create Index @@ -15,6 +23,6 @@ import RestSpecs from '@site/src/components/RestSpecs'; -export const specs = {"summary":"Create Index","deprecated":false,"description":"This creates a named index for a target field, which can either be a vector field or a scalar field.","x-i18n":{"zh-CN":{"summary":"创建索引","description":"为指定的向量字段或标量字段创建一个索引并为其命名。"}},"tags":["Index 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 将导致错误。"}}},"indexParams":{"type":"array","items":{"type":"object","description":"Index parameters for a specific field.","x-i18n":{"zh-CN":{"descripiton":"针对某一字段的索引参数。"}},"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).","x-i18n":{"zh-CN":{"description":"用于构建索引的相似度类型。更多详情，请参考[相似度类型](/docs/search-metrics-explained)。"}},"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).","x-i18n":{"zh-CN":{"description":"索引类型及相关设置。详细信息，请参阅 [向量索引](https://milvus.io/docs/index.md)。"}},"type":"object","properties":{"index_type":{"type":"string","description":"The type of the index to create","x-i18n":{"zh-CN":{"description":"要创建的索引类型。"}}},"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** 的情况。"}}},"efConstruction":{"type":"integer","description":"The search scope. This applies only when **index_type** is set to **HNSW**.","x-i18n":{"zh-CN":{"description":"搜索范围。此参数仅适用于**索引类型**为 **HNSW** 的情况。"}}},"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-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":"应用于索引构建过程的参数。"}}}},"required":["indexParams","collectionName"],"x-i18n-langs":["zh-CN"]},"example":{"collectionName":"custom_setup_not_indexed","indexParams":[{"metricType":"L2","fieldName":"my_vector","indexName":"my_vector","indexConfig":{"index_type":"AUTOINDEX"}}]}}}},"responses":{"200":{"description":"None","content":{"application/json":{"schema":{"oneOf":[{"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"},"data":{"type":"object","properties":{},"description":"Response payload which is an empty object.","x-i18n":{"zh-CN":{"description":"响应载荷。为空对象。"}}}}},{"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 Index","deprecated":false,"description":"This creates a named index for a target field, which can either be a vector field or a scalar field.","x-i18n":{"zh-CN":{"summary":"创建索引","description":"为指定的向量字段或标量字段创建一个索引并为其命名。"}},"tags":["Index 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 所属的数据库名称。设置为不存在的数据库将导致错误。"}}},"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 将导致错误。"}}},"indexParams":{"type":"array","items":{"type":"object","description":"Index parameters for a specific field.","x-i18n":{"zh-CN":{"descripiton":"针对某一字段的索引参数。"}},"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).","x-i18n":{"zh-CN":{"description":"用于构建索引的相似度类型。更多详情，请参考[相似度类型](/docs/search-metrics-explained)。"}},"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).","x-i18n":{"zh-CN":{"description":"索引类型及相关设置。详细信息，请参阅 [向量索引](https://milvus.io/docs/index.md)。"}},"type":"object","properties":{"index_type":{"type":"string","description":"The type of the index to create","x-i18n":{"zh-CN":{"description":"要创建的索引类型。"}}},"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** 的情况。"}}},"efConstruction":{"type":"integer","description":"The search scope. This applies only when **index_type** is set to **HNSW**.","x-i18n":{"zh-CN":{"description":"搜索范围。此参数仅适用于**索引类型**为 **HNSW** 的情况。"}}},"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-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":"应用于索引构建过程的参数。"}}}},"required":["indexParams","collectionName"],"x-i18n-langs":["zh-CN"]},"example":{"collectionName":"custom_setup_not_indexed","indexParams":[{"metricType":"L2","fieldName":"my_vector","indexName":"my_vector","indexConfig":{"index_type":"AUTOINDEX"}}]}}}},"responses":{"200":{"description":"None","content":{"application/json":{"schema":{"oneOf":[{"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"},"data":{"type":"object","properties":{},"description":"Response payload which is an empty object.","x-i18n":{"zh-CN":{"description":"响应载荷。为空对象。"}}}}},{"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":1800,"message":"User hasn't authenticated"}}}}}}},"security":[]} export const endpoint = "/v2/vectordb/indexes/create" export const method = "post" diff --git a/API_Reference_MDX/milvus-restful/v2.5.x/v2/Index (v2)/Describe.mdx b/API_Reference_MDX/milvus-restful/v2.5.x/v2/Index (v2)/Describe.mdx index cc1ce28e5..a2460d322 100644 --- a/API_Reference_MDX/milvus-restful/v2.5.x/v2/Index (v2)/Describe.mdx +++ b/API_Reference_MDX/milvus-restful/v2.5.x/v2/Index (v2)/Describe.mdx @@ -1,12 +1,20 @@ --- displayed_sidebar: restfulSidebar -sidebar_positition: 21 +sidebar_positition: 27 slug: /restful/Describe title: "Describe Index | RESTful" description: "This operation describes the current index. | RESTful" hide_table_of_contents: true sidebar_label: "Describe Index" sidebar_custom_props: { badges: ['post']} +keywords: + - zilliz cloud + - zilliz + - cloud + - "Describe Index" + - "post" + - RESTful + - API --- # Describe Index @@ -15,6 +23,6 @@ import RestSpecs from '@site/src/components/RestSpecs'; -export const specs = {"summary":"Describe Index","deprecated":false,"description":"This operation describes the current index.","x-i18n":{"zh-CN":{"summary":"查看索引详情","description":"本接口可描述当前索引的相关信息。"}},"tags":["Index 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 collection to which the index belongs.","x-i18n":{"zh-CN":{"description":"索引所属的 Collection 名称。"}}},"indexName":{"type":"string","description":"The name of the index to describe.","x-i18n":{"zh-CN":{"description":"要描述的索引的名称。"}}}},"x-i18n-langs":["zh-CN"],"required":["indexName","collectionName"]},"example":{"indexName":"vector","collectionName":"quick_setup"}}}},"responses":{"200":{"description":"An object that contains the detailed description of the current index.","x-i18n":{"zh-CN":{"description":"返回一个包含当前索引详细信息的对象。"}},"content":{"application/json":{"schema":{"oneOf":[{"x-tab-label":"success","type":"object","properties":{"code":{"description":"Response code.","x-i18n":{"zh-CN":{"description":"响应码。"}},"type":"integer","example":0},"data":{"description":"Response payload which is detailed information about the index.","x-i18n":{"zh-CN":{"description":"响应载荷，为索引详细信息。"}},"type":"object","properties":{"fieldName":{"type":"string","description":"The name of the target field.","x-i18n":{"zh-CN":{"description":"目标字段的名称。"}}},"indexName":{"type":"string","description":"The name of the index.","x-i18n":{"zh-CN":{"description":"索引的名称。"}}},"indexState":{"description":"The status of the indexing progress.","x-i18n":{"zh-CN":{"description":"索引当前状态。"}},"type":"string"},"indexType":{"type":"string","description":"The type of this index.","x-i18n":{"zh-CN":{"description":"当前索引的类型。"}}},"indexedRows":{"type":"integer","description":"The total number of entities/rows that have been indexed.","x-i18n":{"zh-CN":{"description":"已索引的 Entity 总数或行数。"}}},"metricType":{"type":"string","description":"The type of the similarity metric.","x-i18n":{"zh-CN":{"description":"相似度类型。"}}},"pendingRows":{"type":"integer","description":"The number of entities/rows that are waiting to be indexed.","x-i18n":{"zh-CN":{"description":"等待被索引的 Entity 总数或行数。"}}},"totalRows":{"type":"integer","description":"The total number of entities/rows.","x-i18n":{"zh-CN":{"description":"Entity 总数或行数。"}}},"failReason":{"type":"string","description":"The reason for the failure to build indexes.","x-i18n":{"zh-CN":{"description":"构建索引失败的原因。"}}}}}},"description":"A success response.","x-i18n":{"zh-CN":{"description":"成功响应。"}}},{"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":[{"failReason":"","fieldName":"vector","indexName":"vector","indexState":"Finished","indexType":"","indexedRows":0,"metricType":"COSINE","pendingRows":0,"totalRows":0}]}},"2":{"summary":"failure","x-target-response":"OPTION 2","value":{"code":0,"message":"The token is illegal."}}}}}}},"security":[]} +export const specs = {"summary":"Describe Index","deprecated":false,"description":"This operation describes the current index.","x-i18n":{"zh-CN":{"summary":"查看索引详情","description":"本接口可描述当前索引的相关信息。"}},"tags":["Index 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 所属的数据库名称。"}}},"collectionName":{"type":"string","description":"The name of the collection to which the index belongs.","x-i18n":{"zh-CN":{"description":"索引所属的 Collection 名称。"}}},"indexName":{"type":"string","description":"The name of the index to describe.","x-i18n":{"zh-CN":{"description":"要描述的索引的名称。"}}}},"x-i18n-langs":["zh-CN"],"required":["indexName","collectionName"]},"example":{"indexName":"vector","collectionName":"quick_setup"}}}},"responses":{"200":{"description":"An object that contains the detailed description of the current index.","x-i18n":{"zh-CN":{"description":"返回一个包含当前索引详细信息的对象。"}},"content":{"application/json":{"schema":{"oneOf":[{"x-tab-label":"success","type":"object","properties":{"code":{"description":"Response code.","x-i18n":{"zh-CN":{"description":"响应码。"}},"type":"integer","example":0},"data":{"description":"Response payload which is detailed information about the index.","x-i18n":{"zh-CN":{"description":"响应载荷，为索引详细信息。"}},"type":"object","properties":{"fieldName":{"type":"string","description":"The name of the target field.","x-i18n":{"zh-CN":{"description":"目标字段的名称。"}}},"indexName":{"type":"string","description":"The name of the index.","x-i18n":{"zh-CN":{"description":"索引的名称。"}}},"indexState":{"description":"The status of the indexing progress.","x-i18n":{"zh-CN":{"description":"索引当前状态。"}},"type":"string"},"indexType":{"type":"string","description":"The type of this index.","x-i18n":{"zh-CN":{"description":"当前索引的类型。"}}},"indexedRows":{"type":"integer","description":"The total number of entities/rows that have been indexed.","x-i18n":{"zh-CN":{"description":"已索引的 Entity 总数或行数。"}}},"metricType":{"type":"string","description":"The type of the similarity metric.","x-i18n":{"zh-CN":{"description":"相似度类型。"}}},"pendingRows":{"type":"integer","description":"The number of entities/rows that are waiting to be indexed.","x-i18n":{"zh-CN":{"description":"等待被索引的 Entity 总数或行数。"}}},"totalRows":{"type":"integer","description":"The total number of entities/rows.","x-i18n":{"zh-CN":{"description":"Entity 总数或行数。"}}},"failReason":{"type":"string","description":"The reason for the failure to build indexes.","x-i18n":{"zh-CN":{"description":"构建索引失败的原因。"}}}}}},"description":"A success response.","x-i18n":{"zh-CN":{"description":"成功响应。"}}},{"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":[{"failReason":"","fieldName":"vector","indexName":"vector","indexState":"Finished","indexType":"","indexedRows":0,"metricType":"COSINE","pendingRows":0,"totalRows":0}]}},"2":{"summary":"failure","x-target-response":"OPTION 2","value":{"code":1800,"message":"User hasn't authenticated"}}}}}}},"security":[]} export const endpoint = "/v2/vectordb/indexes/describe" export const method = "post" diff --git a/API_Reference_MDX/milvus-restful/v2.5.x/v2/Index (v2)/Drop Properties.mdx b/API_Reference_MDX/milvus-restful/v2.5.x/v2/Index (v2)/Drop Properties.mdx new file mode 100644 index 000000000..cabf10ec1 --- /dev/null +++ b/API_Reference_MDX/milvus-restful/v2.5.x/v2/Index (v2)/Drop Properties.mdx @@ -0,0 +1,28 @@ +--- +displayed_sidebar: restfulSidebar +sidebar_positition: 42 +slug: /restful/Drop Properties +title: "Drop Index Properties | RESTful" +description: "This operation drops the properties of an index. | RESTful" +hide_table_of_contents: true +sidebar_label: "Drop Index Properties" +sidebar_custom_props: { badges: ['post']} +keywords: + - zilliz cloud + - zilliz + - cloud + - "Drop Index Properties" + - "post" + - RESTful + - API +--- + +# Drop Index Properties + +import RestSpecs from '@site/src/components/RestSpecs'; + + + +export const specs = {"summary":"Drop Index Properties","deprecated":false,"description":"This operation drops the properties of an index.","x-i18n":{"zh-CN":{"summary":"删除索引属性","description":"本操作删除索引属性。"}},"tags":["Index 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 所属的数据库名称。设置为不存在的数据库将导致错误。"}}},"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 将导致错误。"}}},"indexName":{"type":"string","description":"The name of the target index.","x-i18n":{"zh-CN":{"description":"目标索引的名称。"}}},"propertyKeys":{"type":"array","description":"The names of the properties to drop.","x-i18n":{"zh-CN":{"description":"要删除的属性名称列表。"}},"items":{"type":"string","description":"The name of the property to drop.","x-i18n":{"zh-CN":{"description":"要删除的属性名称。"}},"enum":["mmap.enabled"]}}},"required":["indexName","collectionName","propertyKeys"]},"example":{"collectionName":"test_collection","indexName":"my_vector","propertyKeys":["nlist"]}}}},"responses":{"200":{"description":"Returns an empty response.","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":"响应码。"}}},"data":{"type":"object","properties":{}}}},{"x-tab-label":"failure","description":"Returns an error message.","x-i18n":{"zh-CN":{"description":"返回错误消息。"}},"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":1800,"message":"User hasn't authenticated"}}}}}}}} +export const endpoint = "/v2/vectordb/indexes/drop_properties" +export const method = "post" diff --git a/API_Reference_MDX/milvus-restful/v2.5.x/v2/Index (v2)/Drop.mdx b/API_Reference_MDX/milvus-restful/v2.5.x/v2/Index (v2)/Drop.mdx index 671f115a8..7ca970f20 100644 --- a/API_Reference_MDX/milvus-restful/v2.5.x/v2/Index (v2)/Drop.mdx +++ b/API_Reference_MDX/milvus-restful/v2.5.x/v2/Index (v2)/Drop.mdx @@ -1,12 +1,20 @@ --- displayed_sidebar: restfulSidebar -sidebar_positition: 33 +sidebar_positition: 43 slug: /restful/Drop title: "Drop Index | RESTful" description: "This operation deletes index from a specified collection. | RESTful" hide_table_of_contents: true sidebar_label: "Drop Index" sidebar_custom_props: { badges: ['post']} +keywords: + - zilliz cloud + - zilliz + - cloud + - "Drop Index" + - "post" + - RESTful + - API --- # Drop Index @@ -15,6 +23,6 @@ import RestSpecs from '@site/src/components/RestSpecs'; -export const specs = {"summary":"Drop Index","deprecated":false,"description":"This operation deletes index from a specified collection.","x-i18n":{"zh-CN":{"summary":"删除索引","description":"本接口从指定 Collection 中删除索引。"}},"tags":["Index 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`.","x-i18n":{"zh-CN":{"description":"认证令牌。应为具备适当权限的 API 密钥或用冒号分隔的用户名和密码，如 `username:password`。"}},"required":true,"example":"Bearer {{TOKEN}}","schema":{"type":"string"}}],"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 将导致错误。"}}},"indexName":{"type":"string","description":"The name of the target index.","x-i18n":{"zh-CN":{"description":"目标索引的名称。"}}}},"x-i18n-langs":["zh-CN"],"required":["indexName","collectionName"]},"example":{"indexName":"my_vector","collectionName":"custom_setup_not_indexed"}}}},"responses":{"200":{"description":"None","content":{"application/json":{"schema":{"oneOf":[{"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":"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":"Drop Index","deprecated":false,"description":"This operation deletes index from a specified collection.","x-i18n":{"zh-CN":{"summary":"删除索引","description":"本接口从指定 Collection 中删除索引。"}},"tags":["Index 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`.","x-i18n":{"zh-CN":{"description":"认证令牌。应为具备适当权限的 API 密钥或用冒号分隔的用户名和密码，如 `username:password`。"}},"required":true,"example":"Bearer {{TOKEN}}","schema":{"type":"string"}}],"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 所属的数据库名称。设置为不存在的数据库将导致错误。"}}},"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 将导致错误。"}}},"indexName":{"type":"string","description":"The name of the target index.","x-i18n":{"zh-CN":{"description":"目标索引的名称。"}}}},"x-i18n-langs":["zh-CN"],"required":["indexName","collectionName"]},"example":{"indexName":"my_vector","collectionName":"custom_setup_not_indexed"}}}},"responses":{"200":{"description":"None","content":{"application/json":{"schema":{"oneOf":[{"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":"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":1800,"message":"User hasn't authenticated"}}}}}}},"security":[]} export const endpoint = "/v2/vectordb/indexes/drop" export const method = "post" diff --git a/API_Reference_MDX/milvus-restful/v2.5.x/v2/Index (v2)/Listes.mdx b/API_Reference_MDX/milvus-restful/v2.5.x/v2/Index (v2)/Listes.mdx index 7c6e075e4..d6071e591 100644 --- a/API_Reference_MDX/milvus-restful/v2.5.x/v2/Index (v2)/Listes.mdx +++ b/API_Reference_MDX/milvus-restful/v2.5.x/v2/Index (v2)/Listes.mdx @@ -1,12 +1,20 @@ --- displayed_sidebar: restfulSidebar -sidebar_positition: 46 +sidebar_positition: 56 slug: /restful/Listes title: "List Indexes | RESTful" description: "This operation lists all indexes of a specific collection. | RESTful" hide_table_of_contents: true sidebar_label: "List Indexes" sidebar_custom_props: { badges: ['post']} +keywords: + - zilliz cloud + - zilliz + - cloud + - "List Indexes" + - "post" + - RESTful + - API --- # List Indexes @@ -15,6 +23,6 @@ import RestSpecs from '@site/src/components/RestSpecs'; -export const specs = {"summary":"List Indexes","deprecated":false,"description":"This operation lists all indexes of a specific collection.","x-i18n":{"zh-CN":{"summary":"查看索引列表","description":"本接口可列出指定 Collection 的所有索引。"}},"tags":["Index 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`.","x-i18n":{"zh-CN":{"description":"认证令牌。应为具备适当权限的 API 密钥或用冒号分隔的用户名和密码，如 `username:password`。"}},"required":true,"example":"Bearer {{TOKEN}}","schema":{"type":"string"}}],"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 an existing collection. Setting this to a non-existing collection leads to an error.","x-i18n":{"zh-CN":{"description":"现有 Collection 的名称。设置为一个不存在的 Collection 时会导致报错。 "}}}},"x-i18n-langs":["zh-CN"],"required":["collectionName"]},"example":{"collectionName":"test_collection"}}}},"responses":{"200":{"description":"An object that contains the names of all built indexes.","x-i18n":{"zh-CN":{"description":"返回包含所有已创建索引名称的数组。"}},"content":{"application/json":{"schema":{"oneOf":[{"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":"An index name.","x-i18n":{"zh-CN":{"description":"索引名称。"}}},"description":"Response payload which is a list of indexes.","x-i18n":{"zh-CN":{"description":"响应载荷，为所有索引名称列表。"}}}},"description":"A success response.","x-i18n":{"zh-CN":{"description":"成功响应。"}}},{"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":["my_vector_index"]}},"2":{"summary":"failure","x-target-response":"OPTION 2","value":{"code":0,"message":"The token is illegal."}}}}}}},"security":[]} +export const specs = {"summary":"List Indexes","deprecated":false,"description":"This operation lists all indexes of a specific collection.","x-i18n":{"zh-CN":{"summary":"查看索引列表","description":"本接口可列出指定 Collection 的所有索引。"}},"tags":["Index 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`.","x-i18n":{"zh-CN":{"description":"认证令牌。应为具备适当权限的 API 密钥或用冒号分隔的用户名和密码，如 `username:password`。"}},"required":true,"example":"Bearer {{TOKEN}}","schema":{"type":"string"}}],"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 所属的数据库名称。"}}},"collectionName":{"type":"string","description":"The name of an existing collection. Setting this to a non-existing collection leads to an error.","x-i18n":{"zh-CN":{"description":"现有 Collection 的名称。设置为一个不存在的 Collection 时会导致报错。 "}}}},"x-i18n-langs":["zh-CN"],"required":["collectionName"]},"example":{"collectionName":"test_collection"}}}},"responses":{"200":{"description":"An object that contains the names of all built indexes.","x-i18n":{"zh-CN":{"description":"返回包含所有已创建索引名称的数组。"}},"content":{"application/json":{"schema":{"oneOf":[{"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":"An index name.","x-i18n":{"zh-CN":{"description":"索引名称。"}}},"description":"Response payload which is a list of indexes.","x-i18n":{"zh-CN":{"description":"响应载荷，为所有索引名称列表。"}}}},"description":"A success response.","x-i18n":{"zh-CN":{"description":"成功响应。"}}},{"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":["my_vector_index"]}},"2":{"summary":"failure","x-target-response":"OPTION 2","value":{"code":1800,"message":"User hasn't authenticated"}}}}}}},"security":[]} export const endpoint = "/v2/vectordb/indexes/list" export const method = "post" diff --git a/API_Reference_MDX/milvus-restful/v2.5.x/v2/Partition (v2)/Create.mdx b/API_Reference_MDX/milvus-restful/v2.5.x/v2/Partition (v2)/Create.mdx index 8fea6992d..30dffa447 100644 --- a/API_Reference_MDX/milvus-restful/v2.5.x/v2/Partition (v2)/Create.mdx +++ b/API_Reference_MDX/milvus-restful/v2.5.x/v2/Partition (v2)/Create.mdx @@ -1,12 +1,20 @@ --- displayed_sidebar: restfulSidebar -sidebar_positition: 41 +sidebar_positition: 51 slug: /restful/Create title: "Create Partition | RESTful" description: "This operation creates a partition in a collection. | RESTful" hide_table_of_contents: true sidebar_label: "Create Partition" sidebar_custom_props: { badges: ['post']} +keywords: + - zilliz cloud + - zilliz + - cloud + - "Create Partition" + - "post" + - RESTful + - API --- # Create Partition @@ -15,6 +23,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":"目标 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 所属的数据库名称。设置为不存在的数据库将导致错误。"}}},"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":1800,"message":"User hasn't authenticated"}}}}}}},"security":[]} export const endpoint = "/v2/vectordb/partitions/create" export const method = "post" diff --git a/API_Reference_MDX/milvus-restful/v2.5.x/v2/Partition (v2)/Drop.mdx b/API_Reference_MDX/milvus-restful/v2.5.x/v2/Partition (v2)/Drop.mdx index 43f3ad715..f3b41f9fc 100644 --- a/API_Reference_MDX/milvus-restful/v2.5.x/v2/Partition (v2)/Drop.mdx +++ b/API_Reference_MDX/milvus-restful/v2.5.x/v2/Partition (v2)/Drop.mdx @@ -1,12 +1,20 @@ --- displayed_sidebar: restfulSidebar -sidebar_positition: 80 +sidebar_positition: 90 slug: /restful/Drop title: "Drop Partition | RESTful" description: "This operation drops the current partition. To successfully drop a partition, ensure that the partition is already released. You can use the [Release Partition](/reference/restful/release-partitions-v2) interface to release the partition. | RESTful" hide_table_of_contents: true sidebar_label: "Drop Partition" sidebar_custom_props: { badges: ['post']} +keywords: + - zilliz cloud + - zilliz + - cloud + - "Drop Partition" + - "post" + - RESTful + - API --- # Drop Partition @@ -15,6 +23,6 @@ import RestSpecs from '@site/src/components/RestSpecs'; -export const specs = {"summary":"Drop Partition","deprecated":false,"description":"This operation drops the current partition. To successfully drop a partition, ensure that the partition is already released. You can use the [Release Partition](/reference/restful/release-partitions-v2) interface to release the partition.","x-i18n":{"zh-CN":{"summary":"删除 Partition","description":"本接口可以删除指定 Partition. 在删除 Partition 前，请确保该 Partition 已经从内存中释放。你可以使用[释放 Partition](/reference/restful/release-partitions-v2) 接口释放该 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":"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":0,"message":"The token is illegal."}}}}}}},"security":[]} +export const specs = {"summary":"Drop Partition","deprecated":false,"description":"This operation drops the current partition. To successfully drop a partition, ensure that the partition is already released. You can use the [Release Partition](/reference/restful/release-partitions-v2) interface to release the partition.","x-i18n":{"zh-CN":{"summary":"删除 Partition","description":"本接口可以删除指定 Partition. 在删除 Partition 前，请确保该 Partition 已经从内存中释放。你可以使用[释放 Partition](/reference/restful/release-partitions-v2) 接口释放该 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 所属的数据库名称。设置为不存在的数据库将导致错误。"}}},"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":"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":1800,"message":"User hasn't authenticated"}}}}}}},"security":[]} export const endpoint = "/v2/vectordb/partitions/drop" export const method = "post" diff --git a/API_Reference_MDX/milvus-restful/v2.5.x/v2/Partition (v2)/Get Statistics.mdx b/API_Reference_MDX/milvus-restful/v2.5.x/v2/Partition (v2)/Get Statistics.mdx index 029b7aca0..4f2856411 100644 --- a/API_Reference_MDX/milvus-restful/v2.5.x/v2/Partition (v2)/Get Statistics.mdx +++ b/API_Reference_MDX/milvus-restful/v2.5.x/v2/Partition (v2)/Get Statistics.mdx @@ -1,12 +1,20 @@ --- displayed_sidebar: restfulSidebar -sidebar_positition: 70 +sidebar_positition: 80 slug: /restful/Get Statistics title: "Get Partition Statistics | RESTful" description: "This operations gets the number of entities in a partition. | RESTful" hide_table_of_contents: true sidebar_label: "Get Partition Statistics" sidebar_custom_props: { badges: ['post']} +keywords: + - zilliz cloud + - zilliz + - cloud + - "Get Partition Statistics" + - "post" + - RESTful + - API --- # Get Partition Statistics @@ -15,6 +23,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":"数据库名称。"}}},"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":1800,"message":"User hasn't authenticated"}}}}}}},"security":[]} export const endpoint = "/v2/vectordb/partitions/get_stats" export const method = "post" diff --git a/API_Reference_MDX/milvus-restful/v2.5.x/v2/Partition (v2)/Has.mdx b/API_Reference_MDX/milvus-restful/v2.5.x/v2/Partition (v2)/Has.mdx index 16bece5b5..23283fe20 100644 --- a/API_Reference_MDX/milvus-restful/v2.5.x/v2/Partition (v2)/Has.mdx +++ b/API_Reference_MDX/milvus-restful/v2.5.x/v2/Partition (v2)/Has.mdx @@ -1,12 +1,20 @@ --- displayed_sidebar: restfulSidebar -sidebar_positition: 65 +sidebar_positition: 75 slug: /restful/Has title: "Has Partition | RESTful" description: "This operation checks whether a partition exists. | RESTful" hide_table_of_contents: true sidebar_label: "Has Partition" sidebar_custom_props: { badges: ['post']} +keywords: + - zilliz cloud + - zilliz + - cloud + - "Has Partition" + - "post" + - RESTful + - API --- # Has Partition @@ -15,6 +23,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":"数据库名称。"}}},"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":1800,"message":"User hasn't authenticated"}}}}}}},"security":[]} export const endpoint = "/v2/vectordb/partitions/has" export const method = "post" diff --git a/API_Reference_MDX/milvus-restful/v2.5.x/v2/Partition (v2)/List.mdx b/API_Reference_MDX/milvus-restful/v2.5.x/v2/Partition (v2)/List.mdx index 7e4abf9fd..8288c2ddd 100644 --- a/API_Reference_MDX/milvus-restful/v2.5.x/v2/Partition (v2)/List.mdx +++ b/API_Reference_MDX/milvus-restful/v2.5.x/v2/Partition (v2)/List.mdx @@ -1,12 +1,20 @@ --- displayed_sidebar: restfulSidebar -sidebar_positition: 18 +sidebar_positition: 24 slug: /restful/List title: "List Partitions | RESTful" description: "This operation lists all partitions in the database used in the current connection. | RESTful" hide_table_of_contents: true sidebar_label: "List Partitions" sidebar_custom_props: { badges: ['post']} +keywords: + - zilliz cloud + - zilliz + - cloud + - "List Partitions" + - "post" + - RESTful + - API --- # List Partitions @@ -15,6 +23,6 @@ import RestSpecs from '@site/src/components/RestSpecs'; -export const specs = {"summary":"List Partitions","deprecated":false,"description":"This operation lists all partitions in the database used in the current connection.","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 target database.","x-i18n":{"zh-CN":{"description":"目标数据库名称。"}},"x-include-target":["milvus"]},"collectionName":{"type":"string","description":"The name of the target collection to which the partition belongs.","x-i18n":{"zh-CN":{"description":"当前 Partition 所属的目标 Collection 名称。"}}}},"required":["collectionName"]},"example":{"collectionName":"quick_setup"}}}},"responses":{"200":{"description":"A list of partition names.","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"},"data":{"type":"array","items":{"type":"string","description":"A partition name.","x-i18n":{"zh-CN":{"description":"Partition 名称。"}}},"description":"A list of partition names","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":["_default"]}},"2":{"summary":"failure","x-target-response":"OPTION 2","value":{"summary":"failure","value":{"code":0,"message":"The token is illegal."}}}}}}}},"security":[]} +export const specs = {"summary":"List Partitions","deprecated":false,"description":"This operation lists all partitions in the database used in the current connection.","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 target database.","x-i18n":{"zh-CN":{"description":"目标数据库名称。"}}},"collectionName":{"type":"string","description":"The name of the target collection to which the partition belongs.","x-i18n":{"zh-CN":{"description":"当前 Partition 所属的目标 Collection 名称。"}}}},"required":["collectionName"]},"example":{"collectionName":"quick_setup"}}}},"responses":{"200":{"description":"A list of partition names.","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"},"data":{"type":"array","items":{"type":"string","description":"A partition name.","x-i18n":{"zh-CN":{"description":"Partition 名称。"}}},"description":"A list of partition names","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":["_default"]}},"2":{"summary":"failure","x-target-response":"OPTION 2","value":{"summary":"failure","value":{"code":1800,"message":"User hasn't authenticated"}}}}}}}},"security":[]} export const endpoint = "/v2/vectordb/partitions/list" export const method = "post" diff --git a/API_Reference_MDX/milvus-restful/v2.5.x/v2/Partition (v2)/Load.mdx b/API_Reference_MDX/milvus-restful/v2.5.x/v2/Partition (v2)/Load.mdx index 2c4173831..3347bab0d 100644 --- a/API_Reference_MDX/milvus-restful/v2.5.x/v2/Partition (v2)/Load.mdx +++ b/API_Reference_MDX/milvus-restful/v2.5.x/v2/Partition (v2)/Load.mdx @@ -1,12 +1,20 @@ --- displayed_sidebar: restfulSidebar -sidebar_positition: 52 +sidebar_positition: 62 slug: /restful/Load title: "Load Partitions | RESTful" description: "This operation loads the data of the current partition into memory. | RESTful" hide_table_of_contents: true sidebar_label: "Load Partitions" sidebar_custom_props: { badges: ['post']} +keywords: + - zilliz cloud + - zilliz + - cloud + - "Load Partitions" + - "post" + - RESTful + - API --- # Load Partitions @@ -15,6 +23,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":"加载 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 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 所属的数据库名称。设置为不存在的数据库将导致错误。"}}},"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":1800,"message":"User hasn't authenticated"}}}}}}},"security":[]} export const endpoint = "/v2/vectordb/partitions/load" export const method = "post" diff --git a/API_Reference_MDX/milvus-restful/v2.5.x/v2/Partition (v2)/Release.mdx b/API_Reference_MDX/milvus-restful/v2.5.x/v2/Partition (v2)/Release.mdx index 2226e2014..0be2c7bd5 100644 --- a/API_Reference_MDX/milvus-restful/v2.5.x/v2/Partition (v2)/Release.mdx +++ b/API_Reference_MDX/milvus-restful/v2.5.x/v2/Partition (v2)/Release.mdx @@ -1,12 +1,20 @@ --- displayed_sidebar: restfulSidebar -sidebar_positition: 58 +sidebar_positition: 68 slug: /restful/Release title: "Release Partitions | RESTful" description: "This operation releases the data of the current partition from memory. | RESTful" hide_table_of_contents: true sidebar_label: "Release Partitions" sidebar_custom_props: { badges: ['post']} +keywords: + - zilliz cloud + - zilliz + - cloud + - "Release Partitions" + - "post" + - RESTful + - API --- # Release Partitions @@ -15,6 +23,6 @@ import RestSpecs from '@site/src/components/RestSpecs'; -export const specs = {"summary":"Release Partitions","deprecated":false,"description":"This operation releases the data of the current partition from 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":"An 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":{"partitionNames":["_default","january"],"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":0,"message":"The token is illegal."}}}}}}},"security":[]} +export const specs = {"summary":"Release Partitions","deprecated":false,"description":"This operation releases the data of the current partition from 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 所属的数据库名称。设置为不存在的数据库将导致错误。"}}},"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":"An 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":{"partitionNames":["_default","january"],"collectionName":"quick_setup"}}}},"responses":{"200":{"description":"Returns an empty object.","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":1800,"message":"User hasn't authenticated"}}}}}}},"security":[]} export const endpoint = "/v2/vectordb/partitions/release" export const method = "post" diff --git a/API_Reference_MDX/milvus-restful/v2.5.x/v2/Resource Group (v2)/Transfer Replica.mdx b/API_Reference_MDX/milvus-restful/v2.5.x/v2/Resource Group (v2)/Transfer Replica.mdx new file mode 100644 index 000000000..305d0deb4 --- /dev/null +++ b/API_Reference_MDX/milvus-restful/v2.5.x/v2/Resource Group (v2)/Transfer Replica.mdx @@ -0,0 +1,28 @@ +--- +displayed_sidebar: restfulSidebar +sidebar_positition: 122 +slug: /restful/Transfer Replica +title: "Transfer Collection Replica | RESTful" +description: "This operation transfers the replicas of the specified collection from the source resource group to the target resource group. | RESTful" +hide_table_of_contents: true +sidebar_label: "Transfer Collection Replica" +sidebar_custom_props: { badges: ['post']} +keywords: + - zilliz cloud + - zilliz + - cloud + - "Transfer Collection Replica" + - "post" + - RESTful + - API +--- + +# Transfer Collection Replica + +import RestSpecs from '@site/src/components/RestSpecs'; + + + +export const specs = {"summary":"Transfer Collection Replica","deprecated":false,"description":"This operation transfers the replicas of the specified collection from the source resource group to the target resource group.","x-i18n":{"zh-CN":{"summary":"转移 Collection 副本","description":"本操作将指定 Collection 的副本从源资源组转移到目标资源组。"}},"x-include-target":["milvus"],"tags":["Resource Group (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":{"sourceRgName":{"type":"string","description":"The name of the source resource group.","x-i18n":{"zh-CN":{"description":"源资源组名称。"}}},"targetRgName":{"type":"string","description":"The name of the target resource group.","x-i18n":{"zh-CN":{"description":"目标资源组名称。"}}},"collectionName":{"type":"string","description":"The name of the target collection.","x-i18n":{"zh-CN":{"description":"目标 Collection 名称。"}}},"replicaNum":{"type":"integer","description":"The number of replicas to transfer.","x-i18n":{"zh-CN":{"description":"需要转移的副本数量。"}}}}},"example":{"sourceRgName":"__default_resource_group","targetRgName":"group1","collectionName":"test_collection","replicaNum":1}}}},"responses":{"200":{"description":"Returns an empty object.","x-i18n":{"zh-CN":{"description":"返回空对象。"}},"content":{"application/json":{"schema":{"oneOf":[{"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":"返回错误消息。"}},"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":1800,"message":"User hasn't authenticated"}}}}}}}} +export const endpoint = "/v2/vectordb/resource_groups/transfer_replica" +export const method = "post" diff --git a/API_Reference_MDX/milvus-restful/v2.5.x/v2/Resource Group (v2)/create-resource-group.mdx b/API_Reference_MDX/milvus-restful/v2.5.x/v2/Resource Group (v2)/create-resource-group.mdx new file mode 100644 index 000000000..1bd8c91e1 --- /dev/null +++ b/API_Reference_MDX/milvus-restful/v2.5.x/v2/Resource Group (v2)/create-resource-group.mdx @@ -0,0 +1,28 @@ +--- +displayed_sidebar: restfulSidebar +sidebar_positition: 117 +slug: /restful/create-resource-group +title: "Create Resource Group | RESTful" +description: "This operation creates a resource group. A Milvus instance begins with a default resource group that includes all available query nodes. You can create additional resource groups, reassign specific query nodes from the default group, and load collections into the query nodes in these newly configured groups. This operation always succeeds no matter whether the resource group exists. | RESTful" +hide_table_of_contents: true +sidebar_label: "Create Resource Group" +sidebar_custom_props: { badges: ['post']} +keywords: + - zilliz cloud + - zilliz + - cloud + - "Create Resource Group" + - "post" + - RESTful + - API +--- + +# Create Resource Group + +import RestSpecs from '@site/src/components/RestSpecs'; + + + +export const specs = {"summary":"Create Resource Group","deprecated":false,"description":"This operation creates a resource group. A Milvus instance begins with a default resource group that includes all available query nodes. You can create additional resource groups, reassign specific query nodes from the default group, and load collections into the query nodes in these newly configured groups. This operation always succeeds no matter whether the resource group exists.","x-i18n":{"zh-CN":{"summary":"创建资源组","description":"本操作创建资源组。Milvus 实例在启动后创建一个默认资源组，包含所有可用的 QueryNodes。您可以创建其他资源组，将部分 QueryNodes 从默认组重新分配到这些新配置的组中，并将 Collection 加载到这些新配置的组中的 QueryNodes 上。无论资源组是否存在，此操作都始终成功。"}},"x-include-target":["milvus"],"tags":["Resource Group (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":{"name":{"type":"string","description":"The name of the resource group to create.","x-i18n":{"zh-CN":{"description":"资源组名称。"}}},"config":{"type":"object","description":"The configurations of the resource group to create.","x-i18n":{"zh-CN":{"description":"资源组配置。"}},"properties":{"requests":{"type":"object","description":"The number of query nodes to allocate to the resource group.","x-i18n":{"zh-CN":{"description":"资源组中需要的 QueryNodes 的数量。"}},"properties":{"node_num":{"type":"integer","description":"The number of query nodes to allocate to the resource group.","x-i18n":{"zh-CN":{"description":"资源组中需要的 QueryNodes 的数量。"}}}}},"limits":{"type":"object","description":"The maximum number of query nodes to allocate to the resource group.","x-i18n":{"zh-CN":{"description":"资源组中需要的 QueryNodes 的最大数量。"}},"properties":{"node_num":{"type":"integer","description":"The maximum number of query nodes to allocate to the resource group.","x-i18n":{"zh-CN":{"description":"资源组中需要的 QueryNodes 的最大数量。"}}}}},"transfer_from":{"type":"array","description":"The list of source resource groups to transfer query nodes from.","x-i18n":{"zh-CN":{"description":"需要从哪些源资源组中转移 QueryNodes。"}},"items":{"type":"object","description":"A source resource group to transfer query nodes from.","x-i18n":{"zh-CN":{"description":"当前源资源组。"}},"properties":{"resource_group":{"type":"string","description":"The name of the source resource group to transfer query nodes from.","x-i18n":{"zh-CN":{"description":"当前源资源组名称。"}}}}}},"transfer_to":{"type":"array","description":"The list of target resource groups to transfer query nodes to.","x-i18n":{"zh-CN":{"description":"需要将 QueryNodes 转移到哪些目标资源组中。"}},"items":{"type":"object","description":"A target resource group to transfer query nodes to.","x-i18n":{"zh-CN":{"description":"当前目标资源组。"}},"properties":{"resource_group":{"type":"string","description":"The name of the target resource group to transfer query nodes to.","x-i18n":{"zh-CN":{"description":"当前目标资源组名称。"}}}}}}}}},"required":["name"]},"example":{"name":"group1","config":{"requests":{"node_num":1},"limits":{"node_num":10000},"transfer_from":[{"resource_group":"default"}],"transfer_to":[{"resource_group":"default"}]}}}}},"responses":{"200":{"description":"Returns an empty object.","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":"返回错误消息。"}},"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":1800,"message":"User hasn't authenticated"}}}}}}}} +export const endpoint = "/v2/vectordb/resource_groups/create" +export const method = "post" diff --git a/API_Reference_MDX/milvus-restful/v2.5.x/v2/Resource Group (v2)/describe-resource-group.mdx b/API_Reference_MDX/milvus-restful/v2.5.x/v2/Resource Group (v2)/describe-resource-group.mdx new file mode 100644 index 000000000..8555a498f --- /dev/null +++ b/API_Reference_MDX/milvus-restful/v2.5.x/v2/Resource Group (v2)/describe-resource-group.mdx @@ -0,0 +1,28 @@ +--- +displayed_sidebar: restfulSidebar +sidebar_positition: 119 +slug: /restful/describe-resource-group +title: "Describe Resource Group | RESTful" +description: "This operation returns the configuration of the specified resource group. | RESTful" +hide_table_of_contents: true +sidebar_label: "Describe Resource Group" +sidebar_custom_props: { badges: ['post']} +keywords: + - zilliz cloud + - zilliz + - cloud + - "Describe Resource Group" + - "post" + - RESTful + - API +--- + +# Describe Resource Group + +import RestSpecs from '@site/src/components/RestSpecs'; + + + +export const specs = {"summary":"Describe Resource Group","deprecated":false,"description":"This operation returns the configuration of the specified resource group.","x-i18n":{"zh-CN":{"summary":"查看资源组详情","description":"本操作返回指定资源组的配置。"}},"x-include-target":["milvus"],"tags":["Resource Group (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":{"name":{"type":"string","description":"The name of the resource group to describe.","x-i18n":{"zh-CN":{"description":"需要查看详情的资源组名称。"}}}}},"example":{"name":"group1"}}}},"responses":{"200":{"description":"Returns the configuration of the specified resource group.","x-i18n":{"zh-CN":{"description":"返回指定资源组的配置。"}},"content":{"application/json":{"schema":{"oneOf":[{"x-tab-label":"success","description":"A success response","x-i18n":{"zh-CN":{"description":"成功响应。"}},"type":"object","properties":{"code":{"description":"Response code.","x-i18n":{"zh-CN":{"description":"响应码。"}},"type":"integer","example":0},"data":{"type":"object","properties":{"resource_groups":{"type":"object","description":"The configurations of the resource group to update. You can include multiple resource groups in the request body with the name of each resource group as the key and its configuration as the value.","x-i18n":{"zh-CN":{"description":"需要更新的资源组配置。请求体中可以包含多个资源组的配置，每个资源组的名称作为键，其配置作为值。"}},"properties":{"":{"type":"object","description":"The updated configuration of the resource group specified by the key.","x-18n":{"zh-CN":{"description":"指定资源组的更新配置。"}},"properties":{"requests":{"type":"object","description":"The number of query nodes to allocate to the resource group.","x-i18n":{"zh-CN":{"description":"资源组中需要的 QueryNodes 的数量。"}},"properties":{"node_num":{"type":"integer","description":"The number of query nodes to allocate to the resource group.","x-i18n":{"zh-CN":{"description":"资源组中需要的 QueryNodes 的数量。"}}}}},"limits":{"type":"object","description":"The maximum number of query nodes to allocate to the resource group.","x-i18n":{"zh-CN":{"description":"资源组中需要的 QueryNodes 的最大数量。"}},"properties":{"node_num":{"type":"integer","description":"The maximum number of query nodes to allocate to the resource group.","x-i18n":{"zh-CN":{"description":"资源组中需要的 QueryNodes 的最大数量。"}}}}},"transfer_from":{"type":"array","description":"The list of source resource groups to transfer query nodes from.","x-i18n":{"zh-CN":{"description":"需要从哪些源资源组中转移 QueryNodes。"}},"items":{"type":"object","description":"A source resource group to transfer query nodes from.","x-i18n":{"zh-CN":{"description":"当前源资源组。"}},"properties":{"resource_group":{"type":"string","description":"The name of the source resource group to transfer query nodes from.","x-i18n":{"zh-CN":{"description":"当前源资源组名称。"}}}}}},"transfer_to":{"type":"array","description":"The list of target resource groups to transfer query nodes to.","x-i18n":{"zh-CN":{"description":"需要将 QueryNodes 转移到哪些目标资源组中。"}},"items":{"type":"object","description":"A target resource group to transfer query nodes to.","x-i18n":{"zh-CN":{"description":"当前目标资源组。"}},"properties":{"resource_group":{"type":"string","description":"The name of the target resource group to transfer query nodes to.","x-i18n":{"zh-CN":{"description":"当前目标资源组名称。"}}}}}}}}}}}}}},{"x-tab-label":"failure","description":"Returns an error message.","x-i18n":{"zh-CN":{"description":"返回错误消息。"}},"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":{"resource_groups":{"group1":{"requests":{"node_num":1},"limits":{"node_num":10000},"transfer_from":[{"resource_group":"default"}],"transfer_to":[{"resource_group":"default"}]}}}}},"2":{"summary":"failure","x-target-response":"OPTION 2","value":{"code":1800,"message":"User hasn't authenticated"}}}}}}}} +export const endpoint = "/v2/vectordb/resource_groups/describe" +export const method = "post" diff --git a/API_Reference_MDX/milvus-restful/v2.5.x/v2/Resource Group (v2)/drop-resource-group.mdx b/API_Reference_MDX/milvus-restful/v2.5.x/v2/Resource Group (v2)/drop-resource-group.mdx new file mode 100644 index 000000000..45204dd90 --- /dev/null +++ b/API_Reference_MDX/milvus-restful/v2.5.x/v2/Resource Group (v2)/drop-resource-group.mdx @@ -0,0 +1,28 @@ +--- +displayed_sidebar: restfulSidebar +sidebar_positition: 121 +slug: /restful/drop-resource-group +title: "Drop Resource Group | RESTful" +description: "This operation drops the specified resource group. | RESTful" +hide_table_of_contents: true +sidebar_label: "Drop Resource Group" +sidebar_custom_props: { badges: ['post']} +keywords: + - zilliz cloud + - zilliz + - cloud + - "Drop Resource Group" + - "post" + - RESTful + - API +--- + +# Drop Resource Group + +import RestSpecs from '@site/src/components/RestSpecs'; + + + +export const specs = {"summary":"Drop Resource Group","deprecated":false,"description":"This operation drops the specified resource group.","x-i18n":{"zh-CN":{"summary":"删除资源组","description":"本操作删除指定资源组。"}},"x-include-target":["milvus"],"tags":["Resource Group (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":{"name":{"type":"string","description":"The name of the resource group to drop.","x-i18n":{"zh-CN":{"description":"需要删除的资源组名称。"}}}}},"example":{"name":"group1"}}}},"responses":{"200":{"description":"Returns an empty object.","x-i18n":{"zh-CN":{"description":"返回空对象。"}},"content":{"application/json":{"schema":{"oneOf":[{"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":"返回错误消息。"}},"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":1800,"message":"User hasn't authenticated"}}}}}}}} +export const endpoint = "/v2/vectordb/resource_groups/drop" +export const method = "post" diff --git a/API_Reference_MDX/milvus-restful/v2.5.x/v2/Resource Group (v2)/list-resource-groups.mdx b/API_Reference_MDX/milvus-restful/v2.5.x/v2/Resource Group (v2)/list-resource-groups.mdx new file mode 100644 index 000000000..11e39fa44 --- /dev/null +++ b/API_Reference_MDX/milvus-restful/v2.5.x/v2/Resource Group (v2)/list-resource-groups.mdx @@ -0,0 +1,28 @@ +--- +displayed_sidebar: restfulSidebar +sidebar_positition: 120 +slug: /restful/list-resource-groups +title: "List Resource Groups | RESTful" +description: "This operation returns the list of resource group names. | RESTful" +hide_table_of_contents: true +sidebar_label: "List Resource Groups" +sidebar_custom_props: { badges: ['post']} +keywords: + - zilliz cloud + - zilliz + - cloud + - "List Resource Groups" + - "post" + - RESTful + - API +--- + +# List Resource Groups + +import RestSpecs from '@site/src/components/RestSpecs'; + + + +export const specs = {"summary":"List Resource Groups","deprecated":false,"description":"This operation returns the list of resource group names.","x-i18n":{"zh-CN":{"summary":"查看资源组列表","description":"本操作返回资源组名称列表。"}},"x-include-target":["milvus"],"tags":["Resource Group (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":{}},"example":{}}}},"responses":{"200":{"description":"Returns the list of resource group names.","x-i18n":{"zh-CN":{"description":"返回资源组名称列表。"}},"content":{"application/json":{"schema":{"oneOf":[{"x-tab-label":"success","description":"A success response","x-i18n":{"zh-CN":{"description":"成功响应。"}},"type":"object","properties":{"code":{"description":"Response code.","x-i18n":{"zh-CN":{"description":"响应码。"}},"type":"integer","example":0},"data":{"type":"array","description":"The list of resource group names.","x-i18n":{"zh-CN":{"description":"资源组名称列表。"}},"items":{"type":"string","description":"The name of a resource group.","x-i18n":{"zh-CN":{"description":"资源组名称。"}}}}}},{"x-tab-label":"failure","description":"Returns an error message.","x-i18n":{"zh-CN":{"description":"返回错误消息。"}},"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":["__default_resource_group","group1"]}},"2":{"summary":"failure","x-target-response":"OPTION 2","value":{"code":1800,"message":"User hasn't authenticated"}}}}}}}} +export const endpoint = "/v2/vectordb/resource_groups/list" +export const method = "post" diff --git a/API_Reference_MDX/milvus-restful/v2.5.x/v2/Resource Group (v2)/update-resource-group.mdx b/API_Reference_MDX/milvus-restful/v2.5.x/v2/Resource Group (v2)/update-resource-group.mdx new file mode 100644 index 000000000..ae1e2286e --- /dev/null +++ b/API_Reference_MDX/milvus-restful/v2.5.x/v2/Resource Group (v2)/update-resource-group.mdx @@ -0,0 +1,28 @@ +--- +displayed_sidebar: restfulSidebar +sidebar_positition: 118 +slug: /restful/update-resource-group +title: "Update Resource Group | RESTful" +description: "This operation updates the configuration of the specified resource group. | RESTful" +hide_table_of_contents: true +sidebar_label: "Update Resource Group" +sidebar_custom_props: { badges: ['post']} +keywords: + - zilliz cloud + - zilliz + - cloud + - "Update Resource Group" + - "post" + - RESTful + - API +--- + +# Update Resource Group + +import RestSpecs from '@site/src/components/RestSpecs'; + + + +export const specs = {"summary":"Update Resource Group","deprecated":false,"description":"This operation updates the configuration of the specified resource group.","x-i18n":{"zh-CN":{"summary":"更新资源组","description":"本操作更新指定资源组的配置。"}},"x-include-target":["milvus"],"tags":["Resource Group (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":{"resource_groups":{"type":"object","description":"The configurations of the resource group to update. You can include multiple resource groups in the request body with the name of each resource group as the key and its configuration as the value.","x-i18n":{"zh-CN":{"description":"需要更新的资源组配置。请求体中可以包含多个资源组的配置，每个资源组的名称作为键，其配置作为值。"}},"properties":{"":{"type":"object","description":"The updated configuration of the resource group specified by the key.","x-18n":{"zh-CN":{"description":"指定资源组的更新配置。"}},"properties":{"requests":{"type":"object","description":"The number of query nodes to allocate to the resource group.","x-i18n":{"zh-CN":{"description":"资源组中需要的 QueryNodes 的数量。"}},"properties":{"node_num":{"type":"integer","description":"The number of query nodes to allocate to the resource group.","x-i18n":{"zh-CN":{"description":"资源组中需要的 QueryNodes 的数量。"}}}}},"limits":{"type":"object","description":"The maximum number of query nodes to allocate to the resource group.","x-i18n":{"zh-CN":{"description":"资源组中需要的 QueryNodes 的最大数量。"}},"properties":{"node_num":{"type":"integer","description":"The maximum number of query nodes to allocate to the resource group.","x-i18n":{"zh-CN":{"description":"资源组中需要的 QueryNodes 的最大数量。"}}}}},"transfer_from":{"type":"array","description":"The list of source resource groups to transfer query nodes from.","x-i18n":{"zh-CN":{"description":"需要从哪些源资源组中转移 QueryNodes。"}},"items":{"type":"object","description":"A source resource group to transfer query nodes from.","x-i18n":{"zh-CN":{"description":"当前源资源组。"}},"properties":{"resource_group":{"type":"string","description":"The name of the source resource group to transfer query nodes from.","x-i18n":{"zh-CN":{"description":"当前源资源组名称。"}}}}}},"transfer_to":{"type":"array","description":"The list of target resource groups to transfer query nodes to.","x-i18n":{"zh-CN":{"description":"需要将 QueryNodes 转移到哪些目标资源组中。"}},"items":{"type":"object","description":"A target resource group to transfer query nodes to.","x-i18n":{"zh-CN":{"description":"当前目标资源组。"}},"properties":{"resource_group":{"type":"string","description":"The name of the target resource group to transfer query nodes to.","x-i18n":{"zh-CN":{"description":"当前目标资源组名称。"}}}}}}}}}}}},"example":{"resource_groups":{"group1":{"requests":{"node_num":1},"limits":{"node_num":10000},"transfer_from":[{"resource_group":"default"}],"transfer_to":[{"resource_group":"default"}]}}}}}},"responses":{"200":{"description":"Returns an empty object.","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":"返回错误消息。"}},"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":1800,"message":"User hasn't authenticated"}}}}}}}} +export const endpoint = "/v2/vectordb/resource_groups/alter" +export const method = "post" diff --git a/API_Reference_MDX/milvus-restful/v2.5.x/v2/Role (v2)/Create.mdx b/API_Reference_MDX/milvus-restful/v2.5.x/v2/Role (v2)/Create.mdx index 01e3c6c2c..298cfb18c 100644 --- a/API_Reference_MDX/milvus-restful/v2.5.x/v2/Role (v2)/Create.mdx +++ b/API_Reference_MDX/milvus-restful/v2.5.x/v2/Role (v2)/Create.mdx @@ -1,12 +1,20 @@ --- displayed_sidebar: restfulSidebar -sidebar_positition: 43 +sidebar_positition: 53 slug: /restful/Create title: "Create Role | RESTful" description: "This operation creates a role. | RESTful" hide_table_of_contents: true sidebar_label: "Create Role" sidebar_custom_props: { badges: ['post']} +keywords: + - zilliz cloud + - zilliz + - cloud + - "Create Role" + - "post" + - RESTful + - API --- # Create Role @@ -15,6 +23,6 @@ import RestSpecs from '@site/src/components/RestSpecs'; -export const specs = {"summary":"Create Role","deprecated":false,"description":"This operation creates a role.","x-i18n":{"zh-CN":{"summary":"创建角色","description":"本接口创建一个角色。"}},"x-include-target":["milvus"],"tags":["Role 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`.","x-i18n":{"zh-CN":{"description":"认证令牌。应为具备适当权限的 API 密钥或用冒号分隔的用户名和密码，如 `username:password`。"}},"required":true,"example":"Bearer {{TOKEN}}","schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"roleName":{"type":"string","description":"The name of the role.","x-i18n":{"zh-CN":{"description":"角色名称。"}}}},"required":["roleName"],"x-i18n-langs":["zh-CN"]},"example":{"roleName":"my_role"}}}},"responses":{"200":{"description":"Returns an empty object or an error message.","content":{"application/json":{"schema":{"oneOf":[{"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":"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 Role","deprecated":false,"description":"This operation creates a role.","x-i18n":{"zh-CN":{"summary":"创建角色","description":"本接口创建一个角色。"}},"x-include-target":["milvus"],"tags":["Role 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`.","x-i18n":{"zh-CN":{"description":"认证令牌。应为具备适当权限的 API 密钥或用冒号分隔的用户名和密码，如 `username:password`。"}},"required":true,"example":"Bearer {{TOKEN}}","schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"roleName":{"type":"string","description":"The name of the role.","x-i18n":{"zh-CN":{"description":"角色名称。"}}}},"required":["roleName"],"x-i18n-langs":["zh-CN"]},"example":{"roleName":"my_role"}}}},"responses":{"200":{"description":"Returns an empty object or an error message.","content":{"application/json":{"schema":{"oneOf":[{"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":"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":1800,"message":"User hasn't authenticated"}}}}}}},"security":[]} export const endpoint = "/v2/vectordb/roles/create" export const method = "post" diff --git a/API_Reference_MDX/milvus-restful/v2.5.x/v2/Role (v2)/Describe.mdx b/API_Reference_MDX/milvus-restful/v2.5.x/v2/Role (v2)/Describe.mdx index 50dc90c23..af185d7e6 100644 --- a/API_Reference_MDX/milvus-restful/v2.5.x/v2/Role (v2)/Describe.mdx +++ b/API_Reference_MDX/milvus-restful/v2.5.x/v2/Role (v2)/Describe.mdx @@ -1,12 +1,20 @@ --- displayed_sidebar: restfulSidebar -sidebar_positition: 31 +sidebar_positition: 37 slug: /restful/Describe title: "Describe Role | RESTful" description: "This operation describes the details of a specified role. | RESTful" hide_table_of_contents: true sidebar_label: "Describe Role" sidebar_custom_props: { badges: ['post']} +keywords: + - zilliz cloud + - zilliz + - cloud + - "Describe Role" + - "post" + - RESTful + - API --- # Describe Role @@ -15,6 +23,6 @@ import RestSpecs from '@site/src/components/RestSpecs'; -export const specs = {"summary":"Describe Role","deprecated":false,"description":"This operation describes the details of a specified role.","x-i18n":{"zh-CN":{"summary":"查看角色详情","description":"本接口可列出指定角色的详细信息。"}},"tags":["Role 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":{"roleName":{"type":"string","description":"The name of the role.","x-i18n":{"zh-CN":{"description":"角色名称。"}}}},"required":["roleName"],"x-i18n-langs":["zh-CN"]},"examples":{"1":{"summary":"example","x-include-target":["milvus"],"value":{"roleName":"root"}},"2":{"summary":"example","x-include-target":["zilliz"],"value":{"roleName":"db_admin"}}}}}},"responses":{"200":{"description":"An object that contains the detailed desription of a role.","x-i18n":{"zh-CN":{"description":"返回一个包含指定角色的详细信息对象。"}},"content":{"application/json":{"schema":{"oneOf":[{"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":"array","items":{"description":"A privilege item.","type":"object","properties":{"object_type":{"type":"string","description":"The type of the object to which the privilege belongs.","x-i18n":{"zh-CN":{"description":"当前权限所属对象。"}}},"privilege":{"type":"string","description":"The privilege that is granted to the role.","x-i18n":{"zh-CN":{"description":"授予当前角色的权限名称。"}}},"object_name":{"type":"string","description":"The name of the object to which the role is granted the specified privilege.","x-i18n":{"zh-CN":{"description":"授予当前角色的权限所属的对象名称。"}}},"db_name":{"type":"string","description":"The name of the database in which this operation has been executed.","x-i18n":{"zh-CN":{"description":"当前操作所在数据库名称。"}},"x-include-target":["milvus"]},"grantor":{"type":"string","description":"The name of the user who granted a specific role to a user.","x-i18n":{"zh-CN":{"description":"被授予当前权限的用户名称。"}}}}},"description":"Response payload which is a list of privilege items.","x-i18n":{"zh-CN":{"description":"响应载荷，为权限对象列表。"}}}}},{"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","x-include-target":["milvus"],"value":{"code":0,"data":[{"dbName":"*","grantor":"root","objectName":"*","objectType":"Collection","privilege":"IndexDetail"},{"dbName":"*","grantor":"root","objectName":"*","objectType":"Global","privilege":"DescribeCollection"},{"dbName":"*","grantor":"root","objectName":"*","objectType":"Global","privilege":"ShowCollections"}]}},"2":{"summary":"success","x-target-response":"OPTION 1","x-include-target":["zilliz"],"value":{"code":0,"data":[{"dbName":"*","grantor":"db_admin","objectName":"*","objectType":"Collection","privilege":"IndexDetail"},{"dbName":"*","grantor":"db_admin","objectName":"*","objectType":"Global","privilege":"DescribeCollection"},{"dbName":"*","grantor":"db_admin","objectName":"*","objectType":"Global","privilege":"ShowCollections"}]}},"3":{"summary":"failure","x-target-response":"OPTION 2","value":{"code":0,"message":"The token is illegal."}}}}}}},"security":[]} +export const specs = {"summary":"Describe Role","deprecated":false,"description":"This operation describes the details of a specified role.","x-i18n":{"zh-CN":{"summary":"查看角色详情","description":"本接口可列出指定角色的详细信息。"}},"tags":["Role 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":{"roleName":{"type":"string","description":"The name of the role.","x-i18n":{"zh-CN":{"description":"角色名称。"}}}},"required":["roleName"],"x-i18n-langs":["zh-CN"]},"examples":{"1":{"summary":"example","x-include-target":["milvus"],"value":{"roleName":"root"}},"2":{"summary":"example","x-include-target":["zilliz"],"value":{"roleName":"db_admin"}}}}}},"responses":{"200":{"description":"An object that contains the detailed desription of a role.","x-i18n":{"zh-CN":{"description":"返回一个包含指定角色的详细信息对象。"}},"content":{"application/json":{"schema":{"oneOf":[{"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":"array","items":{"description":"A privilege item.","type":"object","properties":{"object_type":{"type":"string","description":"The type of the object to which the privilege belongs.","x-i18n":{"zh-CN":{"description":"当前权限所属对象。"}}},"privilege":{"type":"string","description":"The privilege that is granted to the role.","x-i18n":{"zh-CN":{"description":"授予当前角色的权限名称。"}}},"object_name":{"type":"string","description":"The name of the object to which the role is granted the specified privilege.","x-i18n":{"zh-CN":{"description":"授予当前角色的权限所属的对象名称。"}}},"db_name":{"type":"string","description":"The name of the database in which this operation has been executed.","x-i18n":{"zh-CN":{"description":"当前操作所在数据库名称。"}},"x-include-target":["milvus"]},"grantor":{"type":"string","description":"The name of the user who granted a specific role to a user.","x-i18n":{"zh-CN":{"description":"被授予当前权限的用户名称。"}}}}},"description":"Response payload which is a list of privilege items.","x-i18n":{"zh-CN":{"description":"响应载荷，为权限对象列表。"}}}}},{"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","x-include-target":["milvus"],"value":{"code":0,"data":[{"dbName":"*","grantor":"root","objectName":"*","objectType":"Collection","privilege":"IndexDetail"},{"dbName":"*","grantor":"root","objectName":"*","objectType":"Global","privilege":"DescribeCollection"},{"dbName":"*","grantor":"root","objectName":"*","objectType":"Global","privilege":"ShowCollections"}]}},"2":{"summary":"success","x-target-response":"OPTION 1","x-include-target":["zilliz"],"value":{"code":0,"data":[{"dbName":"*","grantor":"db_admin","objectName":"*","objectType":"Collection","privilege":"IndexDetail"},{"dbName":"*","grantor":"db_admin","objectName":"*","objectType":"Global","privilege":"DescribeCollection"},{"dbName":"*","grantor":"db_admin","objectName":"*","objectType":"Global","privilege":"ShowCollections"}]}},"3":{"summary":"failure","x-target-response":"OPTION 2","value":{"code":1800,"message":"User hasn't authenticated"}}}}}}},"security":[]} export const endpoint = "/v2/vectordb/roles/describe" export const method = "post" diff --git a/API_Reference_MDX/milvus-restful/v2.5.x/v2/Role (v2)/Drop.mdx b/API_Reference_MDX/milvus-restful/v2.5.x/v2/Role (v2)/Drop.mdx index 02970ef3f..eb96e711b 100644 --- a/API_Reference_MDX/milvus-restful/v2.5.x/v2/Role (v2)/Drop.mdx +++ b/API_Reference_MDX/milvus-restful/v2.5.x/v2/Role (v2)/Drop.mdx @@ -1,12 +1,20 @@ --- displayed_sidebar: restfulSidebar -sidebar_positition: 69 +sidebar_positition: 79 slug: /restful/Drop title: "Drop Role | RESTful" description: "This operation drops an existing role. The operation will succeed if the specified role exists. Otherwise, this operation will fail. | RESTful" hide_table_of_contents: true sidebar_label: "Drop Role" sidebar_custom_props: { badges: ['post']} +keywords: + - zilliz cloud + - zilliz + - cloud + - "Drop Role" + - "post" + - RESTful + - API --- # Drop Role @@ -15,6 +23,6 @@ import RestSpecs from '@site/src/components/RestSpecs'; -export const specs = {"summary":"Drop Role","deprecated":false,"description":"This operation drops an existing role. The operation will succeed if the specified role exists. Otherwise, this operation will fail.","x-i18n":{"zh-CN":{"summary":"删除角色","description":"本接口可以删除指定角色。如果指定的角色存在，操作将成功。否则，操作将失败。"}},"x-include-target":["milvus"],"tags":["Role 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`.","x-i18n":{"zh-CN":{"description":"认证令牌。应为具备适当权限的 API 密钥或用冒号分隔的用户名和密码，如 `username:password`。"}},"required":true,"example":"Bearer {{TOKEN}}","schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"roleName":{"type":"string","description":"The name of the role.","x-i18n":{"zh-CN":{"description":"角色名称。"}}}},"required":["roleName"],"x-i18n-langs":["zh-CN"]},"example":{"roleName":"admin"}}}},"responses":{"200":{"description":"Return an empty object or an error message.","content":{"application/json":{"schema":{"oneOf":[{"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":"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":"Drop Role","deprecated":false,"description":"This operation drops an existing role. The operation will succeed if the specified role exists. Otherwise, this operation will fail.","x-i18n":{"zh-CN":{"summary":"删除角色","description":"本接口可以删除指定角色。如果指定的角色存在，操作将成功。否则，操作将失败。"}},"x-include-target":["milvus"],"tags":["Role 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`.","x-i18n":{"zh-CN":{"description":"认证令牌。应为具备适当权限的 API 密钥或用冒号分隔的用户名和密码，如 `username:password`。"}},"required":true,"example":"Bearer {{TOKEN}}","schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"roleName":{"type":"string","description":"The name of the role.","x-i18n":{"zh-CN":{"description":"角色名称。"}}}},"required":["roleName"],"x-i18n-langs":["zh-CN"]},"example":{"roleName":"admin"}}}},"responses":{"200":{"description":"Return an empty object or an error message.","content":{"application/json":{"schema":{"oneOf":[{"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":"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":1800,"message":"User hasn't authenticated"}}}}}}},"security":[]} export const endpoint = "/v2/vectordb/roles/drop" export const method = "post" diff --git a/API_Reference_MDX/milvus-restful/v2.5.x/v2/Role (v2)/Grant Privilege.mdx b/API_Reference_MDX/milvus-restful/v2.5.x/v2/Role (v2)/Grant Privilege.mdx index cdaeef946..adebd7f77 100644 --- a/API_Reference_MDX/milvus-restful/v2.5.x/v2/Role (v2)/Grant Privilege.mdx +++ b/API_Reference_MDX/milvus-restful/v2.5.x/v2/Role (v2)/Grant Privilege.mdx @@ -1,12 +1,20 @@ --- displayed_sidebar: restfulSidebar -sidebar_positition: 56 +sidebar_positition: 66 slug: /restful/Grant Privilege title: "Grant Privilege To Role | RESTful" description: "This operation grants a privilege to the current role. | RESTful" hide_table_of_contents: true sidebar_label: "Grant Privilege To Role" sidebar_custom_props: { badges: ['post']} +keywords: + - zilliz cloud + - zilliz + - cloud + - "Grant Privilege To Role" + - "post" + - RESTful + - API --- # Grant Privilege To Role @@ -15,6 +23,6 @@ import RestSpecs from '@site/src/components/RestSpecs'; -export const specs = {"summary":"Grant Privilege To Role","deprecated":false,"description":"This operation grants a privilege to the current role.","x-i18n":{"zh-CN":{"summary":"授予角色权限","description":"本接口将相关权限授予当前角色。"}},"x-include-target":["milvus"],"tags":["Role 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":{"roleName":{"type":"string","description":"The name of the role.","x-i18n":{"zh-CN":{"description":"角色名称。"}}},"objectType":{"type":"string","description":" The type of the object to which the privilege belongs.","x-i18n":{"zh-CN":{"description":"待授予权限所属的对象类型。"}}},"objectName":{"type":"string","description":" The name of the object to which the role is granted the specified privilege.","x-i18n":{"zh-CN":{"description":"待授予权限所属的对象名称。"}}},"privilege":{"type":"string","description":" The privilege that is granted to the role.","x-i18n":{"zh-CN":{"description":"待授予权限。"}}}},"required":["objectType","privilege","objectName","roleName"]}}}},"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":0,"message":"The token is illegal."}}}}}}},"security":[]} +export const specs = {"summary":"Grant Privilege To Role","deprecated":false,"description":"This operation grants a privilege to the current role.","x-i18n":{"zh-CN":{"summary":"授予角色权限","description":"本接口将相关权限授予当前角色。"}},"x-include-target":["milvus"],"tags":["Role 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":{"roleName":{"type":"string","description":"The name of the role.","x-i18n":{"zh-CN":{"description":"角色名称。"}}},"objectType":{"type":"string","description":" The type of the object to which the privilege belongs.","x-i18n":{"zh-CN":{"description":"待授予权限所属的对象类型。"}}},"objectName":{"type":"string","description":" The name of the object to which the role is granted the specified privilege.","x-i18n":{"zh-CN":{"description":"待授予权限所属的对象名称。"}}},"privilege":{"type":"string","description":" The privilege that is granted to the role.","x-i18n":{"zh-CN":{"description":"待授予权限。"}}}},"required":["objectType","privilege","objectName","roleName"]}}}},"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":1800,"message":"User hasn't authenticated"}}}}}}},"security":[]} export const endpoint = "/v2/vectordb/roles/grant_privilege" export const method = "post" diff --git a/API_Reference_MDX/milvus-restful/v2.5.x/v2/Role (v2)/Lists.mdx b/API_Reference_MDX/milvus-restful/v2.5.x/v2/Role (v2)/Lists.mdx index 6e64bcb72..64e621d29 100644 --- a/API_Reference_MDX/milvus-restful/v2.5.x/v2/Role (v2)/Lists.mdx +++ b/API_Reference_MDX/milvus-restful/v2.5.x/v2/Role (v2)/Lists.mdx @@ -1,12 +1,20 @@ --- displayed_sidebar: restfulSidebar -sidebar_positition: 20 +sidebar_positition: 26 slug: /restful/Lists title: "List Roles | RESTful" description: "This operation lists the information about all existing roles. | RESTful" hide_table_of_contents: true sidebar_label: "List Roles" sidebar_custom_props: { badges: ['post']} +keywords: + - zilliz cloud + - zilliz + - cloud + - "List Roles" + - "post" + - RESTful + - API --- # List Roles @@ -15,6 +23,6 @@ import RestSpecs from '@site/src/components/RestSpecs'; -export const specs = {"summary":"List Roles","deprecated":false,"description":"This operation lists the information about all existing roles.","x-i18n":{"zh-CN":{"summary":"查看角色列表","description":"本接口可列出所有已创建角色的相关信息。"}},"tags":["Role 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":{},"description":"An empty object.","x-i18n":{"zh-CN":{"description":"空对象"}}},"example":{}}}},"responses":{"200":{"description":"A RoleInfo object that contains a list of RoleItem objects.","x-i18n":{"zh-CN":{"description":"包含 RoleItem 对象列表的 RoleInfo 对象"}},"content":{"application/json":{"schema":{"oneOf":[{"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."},"description":"Response payload which is a list of item objects.","x-i18n":{"zh-CN":{"description":"响应载荷，为元素对象列表。"}}}}},{"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","x-include-target":["milvus"],"value":{"code":0,"data":["admin","public"]}},"2":{"summary":"success","x-target-response":"OPTION 1","x-include-target":["zilliz"],"value":{"code":0,"data":["db_admin","db_ro","db_rw"]}},"3":{"summary":"failure","x-target-response":"OPTION 2","value":{"code":0,"message":"The token is illegal."}}}}}}},"security":[]} +export const specs = {"summary":"List Roles","deprecated":false,"description":"This operation lists the information about all existing roles.","x-i18n":{"zh-CN":{"summary":"查看角色列表","description":"本接口可列出所有已创建角色的相关信息。"}},"tags":["Role 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":{},"description":"An empty object.","x-i18n":{"zh-CN":{"description":"空对象"}}},"example":{}}}},"responses":{"200":{"description":"A RoleInfo object that contains a list of RoleItem objects.","x-i18n":{"zh-CN":{"description":"包含 RoleItem 对象列表的 RoleInfo 对象"}},"content":{"application/json":{"schema":{"oneOf":[{"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."},"description":"Response payload which is a list of item objects.","x-i18n":{"zh-CN":{"description":"响应载荷，为元素对象列表。"}}}}},{"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","x-include-target":["milvus"],"value":{"code":0,"data":["admin","public"]}},"2":{"summary":"success","x-target-response":"OPTION 1","x-include-target":["zilliz"],"value":{"code":0,"data":["db_admin","db_ro","db_rw"]}},"3":{"summary":"failure","x-target-response":"OPTION 2","value":{"code":1800,"message":"User hasn't authenticated"}}}}}}},"security":[]} export const endpoint = "/v2/vectordb/roles/list" export const method = "post" diff --git a/API_Reference_MDX/milvus-restful/v2.5.x/v2/Role (v2)/Revoke Privilege.mdx b/API_Reference_MDX/milvus-restful/v2.5.x/v2/Role (v2)/Revoke Privilege.mdx index 805693765..4926e9f33 100644 --- a/API_Reference_MDX/milvus-restful/v2.5.x/v2/Role (v2)/Revoke Privilege.mdx +++ b/API_Reference_MDX/milvus-restful/v2.5.x/v2/Role (v2)/Revoke Privilege.mdx @@ -1,12 +1,20 @@ --- displayed_sidebar: restfulSidebar -sidebar_positition: 61 +sidebar_positition: 71 slug: /restful/Revoke Privilege title: "Revoke Privilege From Role | RESTful" description: "This operation revokes a privilege granted to the current role. | RESTful" hide_table_of_contents: true sidebar_label: "Revoke Privilege From Role" sidebar_custom_props: { badges: ['post']} +keywords: + - zilliz cloud + - zilliz + - cloud + - "Revoke Privilege From Role" + - "post" + - RESTful + - API --- # Revoke Privilege From Role @@ -15,6 +23,6 @@ import RestSpecs from '@site/src/components/RestSpecs'; -export const specs = {"summary":"Revoke Privilege From Role","deprecated":false,"description":"This operation revokes a privilege granted to the current role.","x-i18n":{"zh-CN":{"summary":"撤销角色权限","description":"本操作可撤销当前角色所授予的权限。"}},"x-include-target":["milvus"],"tags":["Role 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`.","x-i18n":{"zh-CN":{"description":"认证令牌。应为具备适当权限的 API 密钥或用冒号分隔的用户名和密码，如 `username:password`。"}},"required":true,"example":"Bearer {{TOKEN}}","schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"roleName":{"type":"string","description":"The name of the role.","x-i18n":{"zh-CN":{"description":"角色名称。"}}},"objectType":{"type":"string","description":"The type of the object to which the specified privilege belongs.","x-i18n":{"zh-CN":{"description":"指定权限所属的对象类型。"}}},"objectName":{"type":"string","description":"The name of the object to which the specified privilege belongs.","x-i18n":{"zh-CN":{"description":"指定权限所属的对象名称。"}}},"privilege":{"type":"string","description":"The privilege that is revoked from the role.","x-i18n":{"zh-CN":{"description":"当前角色需撤销的权限名称。"}}}},"required":["objectType","privilege","objectName","roleName"],"x-i18n-langs":["zh-CN"]}}}},"responses":{"200":{"description":"Return an empty object or an error message.","content":{"application/json":{"schema":{"oneOf":[{"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":"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":"Revoke Privilege From Role","deprecated":false,"description":"This operation revokes a privilege granted to the current role.","x-i18n":{"zh-CN":{"summary":"撤销角色权限","description":"本操作可撤销当前角色所授予的权限。"}},"x-include-target":["milvus"],"tags":["Role 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`.","x-i18n":{"zh-CN":{"description":"认证令牌。应为具备适当权限的 API 密钥或用冒号分隔的用户名和密码，如 `username:password`。"}},"required":true,"example":"Bearer {{TOKEN}}","schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"roleName":{"type":"string","description":"The name of the role.","x-i18n":{"zh-CN":{"description":"角色名称。"}}},"objectType":{"type":"string","description":"The type of the object to which the specified privilege belongs.","x-i18n":{"zh-CN":{"description":"指定权限所属的对象类型。"}}},"objectName":{"type":"string","description":"The name of the object to which the specified privilege belongs.","x-i18n":{"zh-CN":{"description":"指定权限所属的对象名称。"}}},"privilege":{"type":"string","description":"The privilege that is revoked from the role.","x-i18n":{"zh-CN":{"description":"当前角色需撤销的权限名称。"}}}},"required":["objectType","privilege","objectName","roleName"],"x-i18n-langs":["zh-CN"]}}}},"responses":{"200":{"description":"Return an empty object or an error message.","content":{"application/json":{"schema":{"oneOf":[{"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":"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":1800,"message":"User hasn't authenticated"}}}}}}},"security":[]} export const endpoint = "/v2/vectordb/roles/revoke_privilege" export const method = "post" diff --git a/API_Reference_MDX/milvus-restful/v2.5.x/v2/User (v2)/Create.mdx b/API_Reference_MDX/milvus-restful/v2.5.x/v2/User (v2)/Create.mdx index c194c88a4..bbd58ab59 100644 --- a/API_Reference_MDX/milvus-restful/v2.5.x/v2/User (v2)/Create.mdx +++ b/API_Reference_MDX/milvus-restful/v2.5.x/v2/User (v2)/Create.mdx @@ -1,12 +1,20 @@ --- displayed_sidebar: restfulSidebar -sidebar_positition: 27 +sidebar_positition: 33 slug: /restful/Create title: "Create User | RESTful" description: "This operation creates a new user with a corresponding password. | RESTful" hide_table_of_contents: true sidebar_label: "Create User" sidebar_custom_props: { badges: ['post']} +keywords: + - zilliz cloud + - zilliz + - cloud + - "Create User" + - "post" + - RESTful + - API --- # Create User @@ -15,6 +23,6 @@ import RestSpecs from '@site/src/components/RestSpecs'; -export const specs = {"summary":"Create User","deprecated":false,"description":"This operation creates a new user with a corresponding password.","x-i18n":{"zh-CN":{"summary":"创建用户","description":"本接口可创建新用户并为其设置密码。"}},"tags":["User 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":{"userName":{"type":"string","description":"The name of the target user. The value should start with a letter and can only contain underline, letters and numbers.","x-i18n":{"zh-CN":{"description":"待创建用户的用户名。\n用户名须以字母开头，并包含下划线、字母和数字。"}}},"password":{"type":"string","description":"The corresponding password to the user. \nThe password must must include at least three of the following character types: uppercase letters, lowercase letters, numbers, and special characters.","x-i18n":{"zh-CN":{"description":"用户对应的密码。该密码必须如下字符类型中的三种或以上：大写字母、小写字母、数字和特殊字符。"}},"minLength":8,"maxLength":64,"format":"password"}}},"examples":{"1":{"summary":"example","value":{"userName":"myUser","password":"P@ssw0rd"}}}}}},"responses":{"200":{"description":"None","content":{"application/json":{"schema":{"oneOf":[{"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":"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 User","deprecated":false,"description":"This operation creates a new user with a corresponding password.","x-i18n":{"zh-CN":{"summary":"创建用户","description":"本接口可创建新用户并为其设置密码。"}},"tags":["User 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":{"userName":{"type":"string","description":"The name of the target user. The value should start with a letter and can only contain underline, letters and numbers.","x-i18n":{"zh-CN":{"description":"待创建用户的用户名。\n用户名须以字母开头，并包含下划线、字母和数字。"}}},"password":{"type":"string","description":"The corresponding password to the user. \nThe password must must include at least three of the following character types: uppercase letters, lowercase letters, numbers, and special characters.","x-i18n":{"zh-CN":{"description":"用户对应的密码。该密码必须如下字符类型中的三种或以上：大写字母、小写字母、数字和特殊字符。"}},"minLength":8,"maxLength":64,"format":"password"}}},"examples":{"1":{"summary":"example","value":{"userName":"myUser","password":"P@ssw0rd"}}}}}},"responses":{"200":{"description":"None","content":{"application/json":{"schema":{"oneOf":[{"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":"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":1800,"message":"User hasn't authenticated"}}}}}}},"security":[]} export const endpoint = "/v2/vectordb/users/create" export const method = "post" diff --git a/API_Reference_MDX/milvus-restful/v2.5.x/v2/User (v2)/Describe.mdx b/API_Reference_MDX/milvus-restful/v2.5.x/v2/User (v2)/Describe.mdx index 5ad1c3e21..f550fbb87 100644 --- a/API_Reference_MDX/milvus-restful/v2.5.x/v2/User (v2)/Describe.mdx +++ b/API_Reference_MDX/milvus-restful/v2.5.x/v2/User (v2)/Describe.mdx @@ -1,12 +1,20 @@ --- displayed_sidebar: restfulSidebar -sidebar_positition: 39 +sidebar_positition: 49 slug: /restful/Describe title: "Describe User | RESTful" description: "This operation describes the detailed information of a specific user. | RESTful" hide_table_of_contents: true sidebar_label: "Describe User" sidebar_custom_props: { badges: ['post']} +keywords: + - zilliz cloud + - zilliz + - cloud + - "Describe User" + - "post" + - RESTful + - API --- # Describe User @@ -15,6 +23,6 @@ import RestSpecs from '@site/src/components/RestSpecs'; -export const specs = {"summary":"Describe User","deprecated":false,"description":"This operation describes the detailed information of a specific user.","x-i18n":{"zh-CN":{"summary":"查看用户详情","description":"本接口可列出指定用户的详细信息。"}},"tags":["User 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`.","x-i18n":{"zh-CN":{"description":"认证令牌。应为具备适当权限的 API 密钥或用冒号分隔的用户名和密码，如 `username:password`。"}},"required":true,"example":"Bearer {{TOKEN}}","schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"userName":{"type":"string","description":"The name of the target user. The value should start with a letter and can only contain underline, letters and numbers.","x-i18n":{"zh-CN":{"description":"待创建用户的用户名。\n用户名须以字母开头，并包含下划线、字母和数字。"}}}},"required":["userName"],"x-i18n-langs":["zh-CN"]},"example":{"userName":"my_user"}}}},"responses":{"200":{"description":"Returns the name of the roles assigned to the specified user.","x-i18n":{"zh-CN":{"description":"返回为指定用户所分配的角色名称。"}},"content":{"application/json":{"schema":{"oneOf":[{"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":"The name of a role assigned to the specified user.","x-i18n":{"zh-CN":{"description":"已分配给指定用户的角色名称。"}}},"description":"Response payload which is a list of roles already assigned to the user.","x-i18n":{"zh-CN":{"description":"响应载荷，为已分配给当前用户的角色名称列表。"}}}},"description":"A success response.","x-i18n":{"zh-CN":{"description":"成功响应。"}}},{"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","x-include-target":["zilliz"],"value":{"code":0,"data":["db_admin"]}},"2":{"summary":"success","x-target-response":"OPTION 1","x-include-target":["milvus"],"value":{"code":0,"data":["public"]}},"3":{"summary":"failure","x-target-response":"OPTION 2","value":{"code":0,"message":"The token is illegal."}}}}}}},"security":[]} +export const specs = {"summary":"Describe User","deprecated":false,"description":"This operation describes the detailed information of a specific user.","x-i18n":{"zh-CN":{"summary":"查看用户详情","description":"本接口可列出指定用户的详细信息。"}},"tags":["User 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`.","x-i18n":{"zh-CN":{"description":"认证令牌。应为具备适当权限的 API 密钥或用冒号分隔的用户名和密码，如 `username:password`。"}},"required":true,"example":"Bearer {{TOKEN}}","schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"userName":{"type":"string","description":"The name of the target user. The value should start with a letter and can only contain underline, letters and numbers.","x-i18n":{"zh-CN":{"description":"待创建用户的用户名。\n用户名须以字母开头，并包含下划线、字母和数字。"}}}},"required":["userName"],"x-i18n-langs":["zh-CN"]},"example":{"userName":"my_user"}}}},"responses":{"200":{"description":"Returns the name of the roles assigned to the specified user.","x-i18n":{"zh-CN":{"description":"返回为指定用户所分配的角色名称。"}},"content":{"application/json":{"schema":{"oneOf":[{"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":"The name of a role assigned to the specified user.","x-i18n":{"zh-CN":{"description":"已分配给指定用户的角色名称。"}}},"description":"Response payload which is a list of roles already assigned to the user.","x-i18n":{"zh-CN":{"description":"响应载荷，为已分配给当前用户的角色名称列表。"}}}},"description":"A success response.","x-i18n":{"zh-CN":{"description":"成功响应。"}}},{"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","x-include-target":["zilliz"],"value":{"code":0,"data":["db_admin"]}},"2":{"summary":"success","x-target-response":"OPTION 1","x-include-target":["milvus"],"value":{"code":0,"data":["public"]}},"3":{"summary":"failure","x-target-response":"OPTION 2","value":{"code":1800,"message":"User hasn't authenticated"}}}}}}},"security":[]} export const endpoint = "/v2/vectordb/users/describe" export const method = "post" diff --git a/API_Reference_MDX/milvus-restful/v2.5.x/v2/User (v2)/Drop.mdx b/API_Reference_MDX/milvus-restful/v2.5.x/v2/User (v2)/Drop.mdx index 2d703de9a..8e53488eb 100644 --- a/API_Reference_MDX/milvus-restful/v2.5.x/v2/User (v2)/Drop.mdx +++ b/API_Reference_MDX/milvus-restful/v2.5.x/v2/User (v2)/Drop.mdx @@ -1,12 +1,20 @@ --- displayed_sidebar: restfulSidebar -sidebar_positition: 55 +sidebar_positition: 65 slug: /restful/Drop title: "Drop User | RESTful" description: "This operation deletes an existing user. | RESTful" hide_table_of_contents: true sidebar_label: "Drop User" sidebar_custom_props: { badges: ['post']} +keywords: + - zilliz cloud + - zilliz + - cloud + - "Drop User" + - "post" + - RESTful + - API --- # Drop User @@ -15,6 +23,6 @@ import RestSpecs from '@site/src/components/RestSpecs'; -export const specs = {"summary":"Drop User","deprecated":false,"description":"This operation deletes an existing user.","x-i18n":{"zh-CN":{"summary":"删除用户","description":"本接口会删除一个已存在的用户。"}},"tags":["User 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`.","x-i18n":{"zh-CN":{"description":"认证令牌。应为具备适当权限的 API 密钥或用冒号分隔的用户名和密码，如 `username:password`。"}},"required":true,"example":"Bearer {{TOKEN}}","schema":{"type":"string"},"x-include-target":["milvus"]}],"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"userName":{"type":"string","description":"The name of the target user. The value should start with a letter and can only contain underline, letters and numbers.","x-i18n":{"zh-CN":{"description":"待创建用户的用户名。\n用户名须以字母开头，并包含下划线、字母和数字。"}}}},"required":["userName"],"x-i18n-langs":["zh-CN"]},"example":{"userName":"my_user"}}}},"responses":{"200":{"description":"Return an empty object or an error message.","content":{"application/json":{"schema":{"oneOf":[{"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":"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":"Drop User","deprecated":false,"description":"This operation deletes an existing user.","x-i18n":{"zh-CN":{"summary":"删除用户","description":"本接口会删除一个已存在的用户。"}},"tags":["User 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`.","x-i18n":{"zh-CN":{"description":"认证令牌。应为具备适当权限的 API 密钥或用冒号分隔的用户名和密码，如 `username:password`。"}},"required":true,"example":"Bearer {{TOKEN}}","schema":{"type":"string"},"x-include-target":["milvus"]}],"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"userName":{"type":"string","description":"The name of the target user. The value should start with a letter and can only contain underline, letters and numbers.","x-i18n":{"zh-CN":{"description":"待创建用户的用户名。\n用户名须以字母开头，并包含下划线、字母和数字。"}}}},"required":["userName"],"x-i18n-langs":["zh-CN"]},"example":{"userName":"my_user"}}}},"responses":{"200":{"description":"Return an empty object or an error message.","content":{"application/json":{"schema":{"oneOf":[{"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":"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":1800,"message":"User hasn't authenticated"}}}}}}},"security":[]} export const endpoint = "/v2/vectordb/users/drop" export const method = "post" diff --git a/API_Reference_MDX/milvus-restful/v2.5.x/v2/User (v2)/Grant Role.mdx b/API_Reference_MDX/milvus-restful/v2.5.x/v2/User (v2)/Grant Role.mdx index ffa490365..3d7910794 100644 --- a/API_Reference_MDX/milvus-restful/v2.5.x/v2/User (v2)/Grant Role.mdx +++ b/API_Reference_MDX/milvus-restful/v2.5.x/v2/User (v2)/Grant Role.mdx @@ -1,12 +1,20 @@ --- displayed_sidebar: restfulSidebar -sidebar_positition: 68 +sidebar_positition: 78 slug: /restful/Grant Role title: "Grant Role To User | RESTful" description: "This operation grants a specified role to the current user. Once granted the role, the user gets permissions allowed for the current role and can perform certain operations.To complete this operation, you need to enable authentication on your Milvus instance. For details, refer to [Authenticate User Access](https://milvus.io/docs/authenticate.md). | RESTful" hide_table_of_contents: true sidebar_label: "Grant Role To User" sidebar_custom_props: { badges: ['post']} +keywords: + - zilliz cloud + - zilliz + - cloud + - "Grant Role To User" + - "post" + - RESTful + - API --- # Grant Role To User @@ -15,6 +23,6 @@ import RestSpecs from '@site/src/components/RestSpecs'; -export const specs = {"summary":"Grant Role To User","deprecated":false,"description":"This operation grants a specified role to the current user. Once granted the role, the user gets permissions allowed for the current role and can perform certain operations.To complete this operation, you need to enable authentication on your Milvus instance. For details, refer to [Authenticate User Access](https://milvus.io/docs/authenticate.md).","x-i18n":{"zh-CN":{"summary":"授予用户角色","description":"本接口可以为指定用户分配指定角色。角色授予完成后，用户将获得当前角色所允许的权限，并可以执行相应的操作。"}},"tags":["User 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`.","x-i18n":{"zh-CN":{"description":"认证令牌。应为具备适当权限的 API 密钥或用冒号分隔的用户名和密码，如 `username:password`。"}},"required":true,"example":"Bearer {{TOKEN}}","schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"userName":{"type":"string","description":"The name of the target user. The value should start with a letter and can only contain underline, letters and numbers.","x-i18n":{"zh-CN":{"description":"待创建用户的用户名。\n用户名须以字母开头，并包含下划线、字母和数字。"}}},"roleName":{"type":"string","description":"The name of the target role.","x-i18n":{"zh-CN":{"description":"目标角色名称。"}}}},"required":["roleName","userName"],"x-i18n-langs":["zh-CN"]},"examples":{"1":{"summary":"example","value":{"roleName":"admin","userName":"milvusAdmin"},"x-include-target":["milvus"]},"2":{"summary":"example","value":{"roleName":"db_admin","userName":"myUser"},"x-include-target":["zilliz"]}}}}},"responses":{"200":{"description":"None","content":{"application/json":{"schema":{"oneOf":[{"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":"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":"Grant Role To User","deprecated":false,"description":"This operation grants a specified role to the current user. Once granted the role, the user gets permissions allowed for the current role and can perform certain operations.To complete this operation, you need to enable authentication on your Milvus instance. For details, refer to [Authenticate User Access](https://milvus.io/docs/authenticate.md).","x-i18n":{"zh-CN":{"summary":"授予用户角色","description":"本接口可以为指定用户分配指定角色。角色授予完成后，用户将获得当前角色所允许的权限，并可以执行相应的操作。"}},"tags":["User 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`.","x-i18n":{"zh-CN":{"description":"认证令牌。应为具备适当权限的 API 密钥或用冒号分隔的用户名和密码，如 `username:password`。"}},"required":true,"example":"Bearer {{TOKEN}}","schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"userName":{"type":"string","description":"The name of the target user. The value should start with a letter and can only contain underline, letters and numbers.","x-i18n":{"zh-CN":{"description":"待创建用户的用户名。\n用户名须以字母开头，并包含下划线、字母和数字。"}}},"roleName":{"type":"string","description":"The name of the target role.","x-i18n":{"zh-CN":{"description":"目标角色名称。"}}}},"required":["roleName","userName"],"x-i18n-langs":["zh-CN"]},"examples":{"1":{"summary":"example","value":{"roleName":"admin","userName":"milvusAdmin"},"x-include-target":["milvus"]},"2":{"summary":"example","value":{"roleName":"db_admin","userName":"myUser"},"x-include-target":["zilliz"]}}}}},"responses":{"200":{"description":"None","content":{"application/json":{"schema":{"oneOf":[{"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":"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":1800,"message":"User hasn't authenticated"}}}}}}},"security":[]} export const endpoint = "/v2/vectordb/users/grant_role" export const method = "post" diff --git a/API_Reference_MDX/milvus-restful/v2.5.x/v2/User (v2)/Lists.mdx b/API_Reference_MDX/milvus-restful/v2.5.x/v2/User (v2)/Lists.mdx index a5df9bb12..23d5aff8f 100644 --- a/API_Reference_MDX/milvus-restful/v2.5.x/v2/User (v2)/Lists.mdx +++ b/API_Reference_MDX/milvus-restful/v2.5.x/v2/User (v2)/Lists.mdx @@ -1,12 +1,20 @@ --- displayed_sidebar: restfulSidebar -sidebar_positition: 45 +sidebar_positition: 55 slug: /restful/Lists title: "List Users | RESTful" description: "This operation lists the information of all existing users. | RESTful" hide_table_of_contents: true sidebar_label: "List Users" sidebar_custom_props: { badges: ['post']} +keywords: + - zilliz cloud + - zilliz + - cloud + - "List Users" + - "post" + - RESTful + - API --- # List Users @@ -15,6 +23,6 @@ import RestSpecs from '@site/src/components/RestSpecs'; -export const specs = {"summary":"List Users","deprecated":false,"description":"This operation lists the information of all existing users.","x-i18n":{"zh-CN":{"summary":"查看用户列表","description":"本接口可列出所有已创建用户的相关信息。"}},"tags":["User 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`.","x-i18n":{"zh-CN":{"description":"认证令牌。应为具备适当权限的 API 密钥或用冒号分隔的用户名和密码，如 `username:password`。"}},"required":true,"example":"Bearer {{TOKEN}}","schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{},"description":"An empty object.","x-i18n":{"zh-CN":{"description":"空对象。"}}},"example":{}}}},"responses":{"200":{"description":"An object that contains contains the user information.","x-i18n":{"zh-CN":{"description":"返回包含所有用户名称的数组。"}},"content":{"application/json":{"schema":{"oneOf":[{"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 username.","x-i18n":{"zh-CN":{"description":"用户名。"}}},"description":"Response payload which is a list of usernames.","x-i18n":{"zh-CN":{"description":"响应载荷，为所有用户名列表。"}}}},"description":"A success response.","x-i18n":{"zh-CN":{"description":"成功响应。"}}},{"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","x-include-target":["milvus"],"value":{"code":0,"data":["root"]}},"2":{"summary":"success","x-target-response":"OPTION 1","x-include-target":["zilliz"],"value":{"code":0,"data":["db_admin"]}},"3":{"summary":"failure","x-target-response":"OPTION 2","value":{"code":0,"message":"The token is illegal."}}}}}}},"security":[]} +export const specs = {"summary":"List Users","deprecated":false,"description":"This operation lists the information of all existing users.","x-i18n":{"zh-CN":{"summary":"查看用户列表","description":"本接口可列出所有已创建用户的相关信息。"}},"tags":["User 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`.","x-i18n":{"zh-CN":{"description":"认证令牌。应为具备适当权限的 API 密钥或用冒号分隔的用户名和密码，如 `username:password`。"}},"required":true,"example":"Bearer {{TOKEN}}","schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{},"description":"An empty object.","x-i18n":{"zh-CN":{"description":"空对象。"}}},"example":{}}}},"responses":{"200":{"description":"An object that contains contains the user information.","x-i18n":{"zh-CN":{"description":"返回包含所有用户名称的数组。"}},"content":{"application/json":{"schema":{"oneOf":[{"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 username.","x-i18n":{"zh-CN":{"description":"用户名。"}}},"description":"Response payload which is a list of usernames.","x-i18n":{"zh-CN":{"description":"响应载荷，为所有用户名列表。"}}}},"description":"A success response.","x-i18n":{"zh-CN":{"description":"成功响应。"}}},{"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","x-include-target":["milvus"],"value":{"code":0,"data":["root"]}},"2":{"summary":"success","x-target-response":"OPTION 1","x-include-target":["zilliz"],"value":{"code":0,"data":["db_admin"]}},"3":{"summary":"failure","x-target-response":"OPTION 2","value":{"code":1800,"message":"User hasn't authenticated"}}}}}}},"security":[]} export const endpoint = "/v2/vectordb/users/list" export const method = "post" diff --git a/API_Reference_MDX/milvus-restful/v2.5.x/v2/User (v2)/Revoke Role.mdx b/API_Reference_MDX/milvus-restful/v2.5.x/v2/User (v2)/Revoke Role.mdx index be106c4c8..c07c23f2d 100644 --- a/API_Reference_MDX/milvus-restful/v2.5.x/v2/User (v2)/Revoke Role.mdx +++ b/API_Reference_MDX/milvus-restful/v2.5.x/v2/User (v2)/Revoke Role.mdx @@ -1,12 +1,20 @@ --- displayed_sidebar: restfulSidebar -sidebar_positition: 76 +sidebar_positition: 86 slug: /restful/Revoke Role title: "Revoke Role From User | RESTful" description: "This operation revokes a privilege granted to the current role. | RESTful" hide_table_of_contents: true sidebar_label: "Revoke Role From User" sidebar_custom_props: { badges: ['post']} +keywords: + - zilliz cloud + - zilliz + - cloud + - "Revoke Role From User" + - "post" + - RESTful + - API --- # Revoke Role From User @@ -15,6 +23,6 @@ import RestSpecs from '@site/src/components/RestSpecs'; -export const specs = {"summary":"Revoke Role From User","deprecated":false,"description":"This operation revokes a privilege granted to the current role.","x-i18n":{"zh-CN":{"summary":"撤销用户角色","description":"本接口撤销已授予指定用户的权限。"}},"tags":["User 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`.","x-i18n":{"zh-CN":{"description":"认证令牌。应为具备适当权限的 API 密钥或用冒号分隔的用户名和密码，如 `username:password`。"}},"required":true,"example":"Bearer {{TOKEN}}","schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"userName":{"type":"string","description":"The name of the target user. The value should start with a letter and can only contain underline, letters and numbers.","x-i18n":{"zh-CN":{"description":"待创建用户的用户名。\n用户名须以字母开头，并包含下划线、字母和数字。"}}},"roleName":{"type":"string","description":"The name of the target role.","x-i18n":{"zh-CN":{"description":"目标角色名称。"}}}},"required":["roleName","userName"],"x-i18n-langs":["zh-CN"]},"examples":{"1":{"summary":"example","value":{"roleName":"admin","userName":"milvusAdmin"},"x-include-target":["milvus"]},"2":{"summary":"example","value":{"roleName":"db_admin","userName":"myUser"},"x-include-target":["zilliz"]}}}}},"responses":{"200":{"description":"None","content":{"application/json":{"schema":{"oneOf":[{"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":"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":"Revoke Role From User","deprecated":false,"description":"This operation revokes a privilege granted to the current role.","x-i18n":{"zh-CN":{"summary":"撤销用户角色","description":"本接口撤销已授予指定用户的权限。"}},"tags":["User 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`.","x-i18n":{"zh-CN":{"description":"认证令牌。应为具备适当权限的 API 密钥或用冒号分隔的用户名和密码，如 `username:password`。"}},"required":true,"example":"Bearer {{TOKEN}}","schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"userName":{"type":"string","description":"The name of the target user. The value should start with a letter and can only contain underline, letters and numbers.","x-i18n":{"zh-CN":{"description":"待创建用户的用户名。\n用户名须以字母开头，并包含下划线、字母和数字。"}}},"roleName":{"type":"string","description":"The name of the target role.","x-i18n":{"zh-CN":{"description":"目标角色名称。"}}}},"required":["roleName","userName"],"x-i18n-langs":["zh-CN"]},"examples":{"1":{"summary":"example","value":{"roleName":"admin","userName":"milvusAdmin"},"x-include-target":["milvus"]},"2":{"summary":"example","value":{"roleName":"db_admin","userName":"myUser"},"x-include-target":["zilliz"]}}}}},"responses":{"200":{"description":"None","content":{"application/json":{"schema":{"oneOf":[{"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":"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":1800,"message":"User hasn't authenticated"}}}}}}},"security":[]} export const endpoint = "/v2/vectordb/users/revoke_role" export const method = "post" diff --git a/API_Reference_MDX/milvus-restful/v2.5.x/v2/User (v2)/Update Password.mdx b/API_Reference_MDX/milvus-restful/v2.5.x/v2/User (v2)/Update Password.mdx index 4f2e81d7f..82e1de7c4 100644 --- a/API_Reference_MDX/milvus-restful/v2.5.x/v2/User (v2)/Update Password.mdx +++ b/API_Reference_MDX/milvus-restful/v2.5.x/v2/User (v2)/Update Password.mdx @@ -1,12 +1,20 @@ --- displayed_sidebar: restfulSidebar -sidebar_positition: 60 +sidebar_positition: 70 slug: /restful/Update Password title: "Update User Password | RESTful" description: "This operation updates the password for a specific user. | RESTful" hide_table_of_contents: true sidebar_label: "Update User Password" sidebar_custom_props: { badges: ['post']} +keywords: + - zilliz cloud + - zilliz + - cloud + - "Update User Password" + - "post" + - RESTful + - API --- # Update User Password @@ -15,6 +23,6 @@ import RestSpecs from '@site/src/components/RestSpecs'; -export const specs = {"summary":"Update User Password","deprecated":false,"description":"This operation updates the password for a specific user.","x-i18n":{"zh-CN":{"summary":"更新用户密码","description":"本操作可更新指定用户密码。"}},"tags":["User 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`.","x-i18n":{"zh-CN":{"description":"认证令牌。应为具备适当权限的 API 密钥或用冒号分隔的用户名和密码，如 `username:password`。"}},"required":true,"example":"Bearer {{TOKEN}}","schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"userName":{"type":"string","description":"The name of the target user. The value should start with a letter and can only contain underline, letters and numbers.","x-i18n":{"zh-CN":{"description":"待创建用户的用户名。\n用户名须以字母开头，并包含下划线、字母和数字。"}}},"password":{"type":"string","description":"The corresponding password to the user. \nThe password must be a string of 8 to 64 characters and must include at least three of the following character types: uppercase letters, lowercase letters, numbers, and special characters.","x-i18n":{"zh-CN":{"description":"用户对应的密码。\n密码长度为 8 至 64 个字符，须包含大写字母、小写字母、数字和特殊字符。"}},"minLength":8,"maxLength":64,"format":"password"},"newPassword":{"type":"string","description":"The new password for the user. \nThe password must be a string of 8 to 64 characters and must include at least three of the following character types: uppercase letters, lowercase letters, numbers, and special characters.","x-i18n":{"zh-CN":{"description":"用户的新密码。\n密码长度为 8 至 64 个字符，须包含大写字母、小写字母、数字和特殊字符。"}},"format":"password","minLength":8,"maxLength":64}},"required":["newPassword","userName","password"],"x-i18n-langs":["zh-CN"]},"example":{"newPassword":"P@ssw0rd!","userName":"myUser","password":"P@ssw0rd*"}}}},"responses":{"200":{"description":"Return an empty object or an error message","content":{"application/json":{"schema":{"oneOf":[{"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":"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":"Update User Password","deprecated":false,"description":"This operation updates the password for a specific user.","x-i18n":{"zh-CN":{"summary":"更新用户密码","description":"本操作可更新指定用户密码。"}},"tags":["User 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`.","x-i18n":{"zh-CN":{"description":"认证令牌。应为具备适当权限的 API 密钥或用冒号分隔的用户名和密码，如 `username:password`。"}},"required":true,"example":"Bearer {{TOKEN}}","schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"userName":{"type":"string","description":"The name of the target user. The value should start with a letter and can only contain underline, letters and numbers.","x-i18n":{"zh-CN":{"description":"待创建用户的用户名。\n用户名须以字母开头，并包含下划线、字母和数字。"}}},"password":{"type":"string","description":"The corresponding password to the user. \nThe password must be a string of 8 to 64 characters and must include at least three of the following character types: uppercase letters, lowercase letters, numbers, and special characters.","x-i18n":{"zh-CN":{"description":"用户对应的密码。\n密码长度为 8 至 64 个字符，须包含大写字母、小写字母、数字和特殊字符。"}},"minLength":8,"maxLength":64,"format":"password"},"newPassword":{"type":"string","description":"The new password for the user. \nThe password must be a string of 8 to 64 characters and must include at least three of the following character types: uppercase letters, lowercase letters, numbers, and special characters.","x-i18n":{"zh-CN":{"description":"用户的新密码。\n密码长度为 8 至 64 个字符，须包含大写字母、小写字母、数字和特殊字符。"}},"format":"password","minLength":8,"maxLength":64}},"required":["newPassword","userName","password"],"x-i18n-langs":["zh-CN"]},"example":{"newPassword":"P@ssw0rd!","userName":"myUser","password":"P@ssw0rd*"}}}},"responses":{"200":{"description":"Return an empty object or an error message","content":{"application/json":{"schema":{"oneOf":[{"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":"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":1800,"message":"User hasn't authenticated"}}}}}}},"security":[]} export const endpoint = "/v2/vectordb/users/update_password" export const method = "post" diff --git a/API_Reference_MDX/milvus-restful/v2.5.x/v2/Vector (v2)/Delete.mdx b/API_Reference_MDX/milvus-restful/v2.5.x/v2/Vector (v2)/Delete.mdx index 3694a00fc..7e58f1aeb 100644 --- a/API_Reference_MDX/milvus-restful/v2.5.x/v2/Vector (v2)/Delete.mdx +++ b/API_Reference_MDX/milvus-restful/v2.5.x/v2/Vector (v2)/Delete.mdx @@ -1,12 +1,20 @@ --- displayed_sidebar: restfulSidebar -sidebar_positition: 7 +sidebar_positition: 13 slug: /restful/Delete title: "Delete | RESTful" description: "This operation deletes entities by their IDs or with a boolean expression. | RESTful" hide_table_of_contents: true sidebar_label: "Delete" sidebar_custom_props: { badges: ['post']} +keywords: + - zilliz cloud + - zilliz + - cloud + - "Delete" + - "post" + - RESTful + - API --- # Delete @@ -15,6 +23,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":"删除 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 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":"目标数据库名称。"}}},"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 中删除数据。"}}}},"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":1800,"message":"User hasn't authenticated"}}}}}}},"security":[]} export const endpoint = "/v2/vectordb/entities/delete" export const method = "post" diff --git a/API_Reference_MDX/milvus-restful/v2.5.x/v2/Vector (v2)/Get.mdx b/API_Reference_MDX/milvus-restful/v2.5.x/v2/Vector (v2)/Get.mdx index dd8fafdbc..0a97d3ca0 100644 --- a/API_Reference_MDX/milvus-restful/v2.5.x/v2/Vector (v2)/Get.mdx +++ b/API_Reference_MDX/milvus-restful/v2.5.x/v2/Vector (v2)/Get.mdx @@ -1,12 +1,20 @@ --- displayed_sidebar: restfulSidebar -sidebar_positition: 79 +sidebar_positition: 89 slug: /restful/Get title: "Get | RESTful" description: "This operation gets specific entities by their IDs. | RESTful" hide_table_of_contents: true sidebar_label: "Get" sidebar_custom_props: { badges: ['post']} +keywords: + - zilliz cloud + - zilliz + - cloud + - "Get" + - "post" + - RESTful + - API --- # Get @@ -15,6 +23,6 @@ import RestSpecs from '@site/src/components/RestSpecs'; -export const specs = {"summary":"Get","deprecated":false,"description":"This operation gets specific entities by their IDs.","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 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 名称。"}}},"id":{"type":"string | integer | string[] | integer[]","description":"A specific entity ID or a list of entity IDs.","x-i18n":{"zh-CN":{"description":"Entity ID 或 Entity ID 列表。"}}},"outputFields":{"type":"array","items":{"type":"string","description":"An output field name.","x-i18n":{"zh-CN":{"description":"随查询结果返回的字段名称。"}}},"description":"An array of fields to return along with the query results.","x-i18n":{"zh-CN":{"description":"需要随查询结果返回的字段列表。"}}},"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.","x-i18n":{"zh-CN":{"description":"Partition 名称列表。"}}}},"required":["collectionName","id"]},"example":{"collectionName":"quick_setup","id":[1,3,5],"outputFields":["color"]}}}},"responses":{"200":{"description":"Returns the query 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":"Query results.","x-i18n":{"zh-CN":{"description":"查询结果。"}},"items":{"type":"object","description":"An entity object.","x-i18n":{"zh-CN":{"description":"返回的一个 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,"data":[{"color":"red_7025","id":1},{"color":"pink_9298","id":3},{"color":"yellow_4222","id":5}]}},"2":{"summary":"failure","x-target-response":"OPTION 2","value":{"code":0,"message":"The token is illegal."}}}}}}},"security":[]} +export const specs = {"summary":"Get","deprecated":false,"description":"This operation gets specific entities by their IDs.","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 database.","x-i18n":{"zh-CN":{"description":"数据库名称。"}}},"collectionName":{"type":"string","description":"The name of the collection to which this operation applies.","x-i18n":{"zh-CN":{"description":"Collection 名称。"}}},"id":{"type":"string | integer | string[] | integer[]","description":"A specific entity ID or a list of entity IDs.","x-i18n":{"zh-CN":{"description":"Entity ID 或 Entity ID 列表。"}}},"outputFields":{"type":"array","items":{"type":"string","description":"An output field name.","x-i18n":{"zh-CN":{"description":"随查询结果返回的字段名称。"}}},"description":"An array of fields to return along with the query results.","x-i18n":{"zh-CN":{"description":"需要随查询结果返回的字段列表。"}}},"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.","x-i18n":{"zh-CN":{"description":"Partition 名称列表。"}}}},"required":["collectionName","id"]},"example":{"collectionName":"quick_setup","id":[1,3,5],"outputFields":["color"]}}}},"responses":{"200":{"description":"Returns the query 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":"Query results.","x-i18n":{"zh-CN":{"description":"查询结果。"}},"items":{"type":"object","description":"An entity object.","x-i18n":{"zh-CN":{"description":"返回的一个 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,"data":[{"color":"red_7025","id":1},{"color":"pink_9298","id":3},{"color":"yellow_4222","id":5}]}},"2":{"summary":"failure","x-target-response":"OPTION 2","value":{"code":1800,"message":"User hasn't authenticated"}}}}}}},"security":[]} export const endpoint = "/v2/vectordb/entities/get" export const method = "post" diff --git a/API_Reference_MDX/milvus-restful/v2.5.x/v2/Vector (v2)/Hybrid Search.mdx b/API_Reference_MDX/milvus-restful/v2.5.x/v2/Vector (v2)/Hybrid Search.mdx index 9dfe67ceb..a55f62829 100644 --- a/API_Reference_MDX/milvus-restful/v2.5.x/v2/Vector (v2)/Hybrid Search.mdx +++ b/API_Reference_MDX/milvus-restful/v2.5.x/v2/Vector (v2)/Hybrid Search.mdx @@ -1,12 +1,20 @@ --- displayed_sidebar: restfulSidebar -sidebar_positition: 77 +sidebar_positition: 87 slug: /restful/Hybrid Search title: "Hybrid Search | RESTful" description: "This operation searches for entities based on vector similarity and scalar filtering and reranks the results using a specified strategy. | RESTful" hide_table_of_contents: true sidebar_label: "Hybrid Search" sidebar_custom_props: { badges: ['post']} +keywords: + - zilliz cloud + - zilliz + - cloud + - "Hybrid Search" + - "post" + - RESTful + - API --- # Hybrid Search @@ -15,6 +23,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":"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 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":"数据库名称。"}}},"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":"搜索结果中需要包含的字段列表。"}}},"consistencyLevel":{"type":"string","description":"The consistency level of the search operation. The value should be the same as the consistency level of the target collection.","x-i18n":{"zh-CN":{"description":"当前搜索操作的一致性级别。"}},"enum":["Strong","Eventually","Session","Bounded"],"default":"Bounded"}},"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":1800,"message":"User hasn't authenticated"}}}}}}},"security":[]} export const endpoint = "/v2/vectordb/entities/hybrid_search" export const method = "post" diff --git a/API_Reference_MDX/milvus-restful/v2.5.x/v2/Vector (v2)/Insert.mdx b/API_Reference_MDX/milvus-restful/v2.5.x/v2/Vector (v2)/Insert.mdx index 748b67e5a..3797077ae 100644 --- a/API_Reference_MDX/milvus-restful/v2.5.x/v2/Vector (v2)/Insert.mdx +++ b/API_Reference_MDX/milvus-restful/v2.5.x/v2/Vector (v2)/Insert.mdx @@ -1,12 +1,20 @@ --- displayed_sidebar: restfulSidebar -sidebar_positition: 24 +sidebar_positition: 30 slug: /restful/Insert title: "Insert | RESTful" description: "This operation inserts data into a specific collection. | RESTful" hide_table_of_contents: true sidebar_label: "Insert" sidebar_custom_props: { badges: ['post']} +keywords: + - zilliz cloud + - zilliz + - cloud + - "Insert" + - "post" + - RESTful + - API --- # Insert @@ -15,6 +23,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":"插入 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 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":"目标数据库名称。"}}},"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":1800,"message":"User hasn't authenticated"}}}}}}},"security":[]} export const endpoint = "/v2/vectordb/entities/insert" export const method = "post" diff --git a/API_Reference_MDX/milvus-restful/v2.5.x/v2/Vector (v2)/Query.mdx b/API_Reference_MDX/milvus-restful/v2.5.x/v2/Vector (v2)/Query.mdx index b61172ec7..981d9c02c 100644 --- a/API_Reference_MDX/milvus-restful/v2.5.x/v2/Vector (v2)/Query.mdx +++ b/API_Reference_MDX/milvus-restful/v2.5.x/v2/Vector (v2)/Query.mdx @@ -1,12 +1,20 @@ --- displayed_sidebar: restfulSidebar -sidebar_positition: 66 +sidebar_positition: 76 slug: /restful/Query title: "Query | RESTful" description: "This operation conducts a filtering on the scalar field with a specified boolean expression. | RESTful" hide_table_of_contents: true sidebar_label: "Query" sidebar_custom_props: { badges: ['post']} +keywords: + - zilliz cloud + - zilliz + - cloud + - "Query" + - "post" + - RESTful + - API --- # Query @@ -15,6 +23,6 @@ import RestSpecs from '@site/src/components/RestSpecs'; -export const specs = {"summary":"Query","deprecated":false,"description":"This operation conducts a filtering on the scalar field with a specified boolean expression.","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":false,"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 名称。"}}},"filter":{"type":"string","description":"The filter used to find matches for the search.","x-i18n":{"zh-CN":{"description":"用于对标量字段进行过滤的表达式。"}}},"outputFields":{"type":"array","items":{"type":"string","description":"An output field name.","x-i18n":{"zh-CN":{"description":"随查询结果返回的字段名称。"}}},"description":"An array of fields to return along with the query results.","x-i18n":{"zh-CN":{"description":"需要在查询结果中返回的字名称数组。"}}},"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 restricts the operation to the specified partitions. If not set, the operation applies to all partitions in the collection.","x-i18n":{"zh-CN":{"description":"Partition 名称列表。设置此参数可限制操作范围到指定的 Partition。未设置时，操作范围为 Collection 中的所有 Partition。"}}},"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您可以使用此参数与 **offset** 参数结合使用以实现分页。\n此值与 **offset** 参数之和不应超过 16,384。"}}},"offset":{"type":"integer","description":"The number of records to skip in the search result. \nYou can use this parameter in combination with limit to enable pagination. \nThe sum of this value and limit should be less than 16,384. ","x-i18n":{"zh-CN":{"description":"需要在搜索结果中跳过的 Entity 数量。\n您可以使用此参数与 **limit** 参数结合使用以实现分页。\n此值与 **limit** 参数之和不应超过 16,384。"}}}},"required":["collectionName","filter"]},"example":{"collectionName":"quick_setup","filter":"color like \"red_%\"","outputFields":["color"],"limit":3}}}},"responses":{"200":{"description":"A list of dictionaries with each dictionary representing a queried entity.","x-i18n":{"zh-CN":{"description":"返回查询到的 Entity 列表，每个字典表示一个查询到的 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":"array","description":"A list of dictionaries with each dictionary representing a queried entity.","x-i18n":{"zh-CN":{"description":"查询到的 Entity 列表，每个字典表示一个查询到的 Entity。"}},"items":{"type":"object","properties":{},"description":"An entity object","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,"cost":0,"data":[{"color":"red_7025","id":1},{"color":"red_4794","id":4},{"color":"red_9392","id":6}]}},"2":{"summary":"failure","x-target-response":"OPTION 2","value":{"code":0,"message":"The token is illegal."}}}}}}},"security":[]} +export const specs = {"summary":"Query","deprecated":false,"description":"This operation conducts a filtering on the scalar field with a specified boolean expression.","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":false,"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":"数据库名称。"}}},"collectionName":{"type":"string","description":"The name of the collection to which this operation applies.","x-i18n":{"zh-CN":{"description":"Collection 名称。"}}},"filter":{"type":"string","description":"The filter used to find matches for the search.","x-i18n":{"zh-CN":{"description":"用于对标量字段进行过滤的表达式。"}}},"outputFields":{"type":"array","items":{"type":"string","description":"An output field name.","x-i18n":{"zh-CN":{"description":"随查询结果返回的字段名称。"}}},"description":"An array of fields to return along with the query results.","x-i18n":{"zh-CN":{"description":"需要在查询结果中返回的字名称数组。"}}},"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 restricts the operation to the specified partitions. If not set, the operation applies to all partitions in the collection.","x-i18n":{"zh-CN":{"description":"Partition 名称列表。设置此参数可限制操作范围到指定的 Partition。未设置时，操作范围为 Collection 中的所有 Partition。"}}},"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您可以使用此参数与 **offset** 参数结合使用以实现分页。\n此值与 **offset** 参数之和不应超过 16,384。"}}},"offset":{"type":"integer","description":"The number of records to skip in the search result. \nYou can use this parameter in combination with limit to enable pagination. \nThe sum of this value and limit should be less than 16,384. ","x-i18n":{"zh-CN":{"description":"需要在搜索结果中跳过的 Entity 数量。\n您可以使用此参数与 **limit** 参数结合使用以实现分页。\n此值与 **limit** 参数之和不应超过 16,384。"}}}},"required":["collectionName","filter"]},"example":{"collectionName":"quick_setup","filter":"color like \"red_%\"","outputFields":["color"],"limit":3}}}},"responses":{"200":{"description":"A list of dictionaries with each dictionary representing a queried entity.","x-i18n":{"zh-CN":{"description":"返回查询到的 Entity 列表，每个字典表示一个查询到的 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":"array","description":"A list of dictionaries with each dictionary representing a queried entity.","x-i18n":{"zh-CN":{"description":"查询到的 Entity 列表，每个字典表示一个查询到的 Entity。"}},"items":{"type":"object","properties":{},"description":"An entity object","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,"cost":0,"data":[{"color":"red_7025","id":1},{"color":"red_4794","id":4},{"color":"red_9392","id":6}]}},"2":{"summary":"failure","x-target-response":"OPTION 2","value":{"code":1800,"message":"User hasn't authenticated"}}}}}}},"security":[]} export const endpoint = "/v2/vectordb/entities/query" export const method = "post" diff --git a/API_Reference_MDX/milvus-restful/v2.5.x/v2/Vector (v2)/Search.mdx b/API_Reference_MDX/milvus-restful/v2.5.x/v2/Vector (v2)/Search.mdx index 9a668c8d5..32c8380c5 100644 --- a/API_Reference_MDX/milvus-restful/v2.5.x/v2/Vector (v2)/Search.mdx +++ b/API_Reference_MDX/milvus-restful/v2.5.x/v2/Vector (v2)/Search.mdx @@ -1,12 +1,20 @@ --- displayed_sidebar: restfulSidebar -sidebar_positition: 75 +sidebar_positition: 85 slug: /restful/Search title: "Search | RESTful" description: "This operation conducts a vector similarity search with an optional scalar filtering expression. | RESTful" hide_table_of_contents: true sidebar_label: "Search" sidebar_custom_props: { badges: ['post']} +keywords: + - zilliz cloud + - zilliz + - cloud + - "Search" + - "post" + - RESTful + - API --- # Search @@ -15,6 +23,6 @@ import RestSpecs from '@site/src/components/RestSpecs'; -export const specs = {"summary":"Search","deprecated":false,"description":"This operation conducts a vector similarity search with an optional scalar filtering expression.","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":"数据库名称。"}}},"collectionName":{"type":"string","description":"The name of the collection to which this operation applies.","x-i18n":{"zh-CN":{"description":"当前操作的目标 Collection 名称。"}}},"data":{"type":"array","items":{"type":"number","description":"A vector embedding","x-i18n":{"zh-CN":{"description":"一个向量嵌入。"}},"format":"float32"},"description":"A list of vector embeddings.\nMilvusZilliz Cloud searches for the most similar vector embeddings to the specified ones.","x-i18n":{"zh-CN":{"description":"一个向量嵌入列表。\nMilvusZilliz Cloud 会搜索与指定向量嵌入最相似的向量。"}}},"annsField":{"type":"string","description":"The name of the vector field.","x-i18n":{"zh-CN":{"description":"向量字段名称。"}}},"filter":{"type":"string","description":"The filter used to find matches for the search.","x-i18n":{"zh-CN":{"description":"在检索结果中根据标量字段进行过滤的表达式。"}}},"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您可以使用此参数与 **offset** 参数结合使用以实现分页。\n此值与 **offset** 参数之和不应超过 16,384。"}}},"offset":{"type":"integer","description":"The number of records to skip in the search result. \nYou can use this parameter in combination with limit to enable pagination. \nThe sum of this value and limit should be less than 16,384. ","x-i18n":{"zh-CN":{"description":"需要在搜索结果中跳过的 Entity 数量。\n您可以使用此参数与 **limit** 参数结合使用以实现分页。\n此值与 **limit** 参数之和不应超过 16,384。"}}},"groupingField":{"type":"string","description":"The name of the field that serves as the aggregation criteria.","x-i18n":{"zh-CN":{"description":"充当分组聚合条件的字段名称。"}}},"groupSize":{"type":"integer","description":"The target number of entities to return within each group in a grouping search. For example, setting `groupSize=2` instructs the system to return up to 2 of the most similar entities (e.g., document passages or vector representations) within each group. Without setting `groupSize`, the system defaults to returning only 1 entity per group.","x-i18n":{"zh-CN":{"description":"在分组搜索中，每个组中需要返回的目标 Entity 数量。例如，在 `groupSize=2` 的情况下，系统会返回每个组中最相似的两个 Entity（文档段落或向量表示）。如果不设置 `groupSize`，系统会默认返回每个组中的一个 Entity。"}},"x-include-target":["milvus"]},"strictGroupSize":{"type":"boolean","description":"This Boolean parameter dictates whether `groupSize` should be strictly enforced. When `groupStrictSize=True`, the system will attempt to fill each group with exactly `groupSize` results, as long as sufficient data exists within each group. If there is an insufficient number of entities in a group, it will return only the available entities, ensuring that groups with adequate data meet the specified `groupSize`.","x-i18n":{"zh-CN":{"description":"布尔参数，用于确定是否严格执行 `groupSize`。当 `groupStrictSize=True` 时，系统会尝试将每个组填满 `groupSize` 个结果，只要每个组中存在足够的数据。如果某个组中的 Entity 数量不足，系统会只返回可用的 Entity，确保组中有足够的数据符合指定的 `groupSize`。"}},"x-include-target":["milvus"]},"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":"需要在搜索结果中包含的字段名称列表。"}}},"searchParams":{"description":"The parameter settings specific to this operation.","x-i18n":{"zh-CN":{"description":"当前操作的附加参数。"}},"type":"object","properties":{"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"},"params":{"description":"Extra search parameters.","x-i18n":{"zh-CN":{"description":"其它附加参数。"}},"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 的值。"}}}}}}},"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。"}}}},"required":["collectionName","data","annsField"]},"example":{"collectionName":"quick_setup","data":[[0.3580376395471989,-0.6023495712049978,0.18414012509913835,-0.26286205330961354,0.9029438446296592]],"annsField":"vector","limit":3,"outputFields":["color"]}}}},"responses":{"200":{"description":"Returns the search results.","x-i18n":{"zh-CN":{"description":"返回搜索结果。"}},"content":{"application/json":{"schema":{"anyOf":[{"type":"object","x-tab-label":"success","properties":{"code":{"type":"integer","description":"Response code.","x-i18n":{"zh-CN":{"description":"响应码。"}}},"data":{"type":"array","description":"A list of entity objects.","x-i18n":{"zh-CN":{"description":"搜索结果，为一组 Entity 对象。"}},"items":{"type":"object","description":"An entity object.","x-i18n":{"zh-CN":{"description":"一个返回的 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,"data":[{"color":"orange_6781","distance":1,"id":448300048035776800},{"color":"red_4794","distance":0.9353201,"id":448300048035776800},{"color":"grey_8510","distance":0.7733054,"id":448300048035776800}]}},"2":{"summary":"failure","x-target-response":"OPTION 2","value":{"code":1802,"message":"reason for failure"}}}}}}},"security":[]} +export const specs = {"summary":"Search","deprecated":false,"description":"This operation conducts a vector similarity search with an optional scalar filtering expression.","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":"数据库名称。"}}},"collectionName":{"type":"string","description":"The name of the collection to which this operation applies.","x-i18n":{"zh-CN":{"description":"当前操作的目标 Collection 名称。"}}},"data":{"type":"array","items":{"type":"number","description":"A vector embedding","x-i18n":{"zh-CN":{"description":"一个向量嵌入。"}},"format":"float32"},"description":"A list of vector embeddings.\nMilvusZilliz Cloud searches for the most similar vector embeddings to the specified ones.","x-i18n":{"zh-CN":{"description":"一个向量嵌入列表。\nMilvusZilliz Cloud 会搜索与指定向量嵌入最相似的向量。"}}},"annsField":{"type":"string","description":"The name of the vector field.","x-i18n":{"zh-CN":{"description":"向量字段名称。"}}},"filter":{"type":"string","description":"The filter used to find matches for the search.","x-i18n":{"zh-CN":{"description":"在检索结果中根据标量字段进行过滤的表达式。"}}},"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您可以使用此参数与 **offset** 参数结合使用以实现分页。\n此值与 **offset** 参数之和不应超过 16,384。"}}},"offset":{"type":"integer","description":"The number of records to skip in the search result. \nYou can use this parameter in combination with limit to enable pagination. \nThe sum of this value and limit should be less than 16,384. ","x-i18n":{"zh-CN":{"description":"需要在搜索结果中跳过的 Entity 数量。\n您可以使用此参数与 **limit** 参数结合使用以实现分页。\n此值与 **limit** 参数之和不应超过 16,384。"}}},"groupingField":{"type":"string","description":"The name of the field that serves as the aggregation criteria.","x-i18n":{"zh-CN":{"description":"充当分组聚合条件的字段名称。"}}},"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":"需要在搜索结果中包含的字段名称列表。"}}},"searchParams":{"description":"The parameter settings specific to this operation.","x-i18n":{"zh-CN":{"description":"当前操作的附加参数。"}},"type":"object","properties":{"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"},"params":{"description":"Extra search parameters.","x-i18n":{"zh-CN":{"description":"其它附加参数。"}},"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 的值。"}}}}}}},"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。"}}},"consistencyLevel":{"type":"string","description":"The consistency level of the search operation. The value should be the same as the consistency level of the target collection.","x-i18n":{"zh-CN":{"description":"当前搜索操作的一致性级别。"}},"enum":["Strong","Eventually","Session","Bounded"],"default":"Bounded"}},"required":["collectionName","data","annsField"]},"example":{"collectionName":"quick_setup","data":[[0.3580376395471989,-0.6023495712049978,0.18414012509913835,-0.26286205330961354,0.9029438446296592]],"annsField":"vector","limit":3,"outputFields":["color"]}}}},"responses":{"200":{"description":"Returns the search results.","x-i18n":{"zh-CN":{"description":"返回搜索结果。"}},"content":{"application/json":{"schema":{"anyOf":[{"type":"object","x-tab-label":"success","properties":{"code":{"type":"integer","description":"Response code.","x-i18n":{"zh-CN":{"description":"响应码。"}}},"data":{"type":"array","description":"A list of entity objects.","x-i18n":{"zh-CN":{"description":"搜索结果，为一组 Entity 对象。"}},"items":{"type":"object","description":"An entity object.","x-i18n":{"zh-CN":{"description":"一个返回的 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,"data":[{"color":"orange_6781","distance":1,"id":448300048035776800},{"color":"red_4794","distance":0.9353201,"id":448300048035776800},{"color":"grey_8510","distance":0.7733054,"id":448300048035776800}]}},"2":{"summary":"failure","x-target-response":"OPTION 2","value":{"code":1800,"message":"User hasn't authenticated"}}}}}}},"security":[]} export const endpoint = "/v2/vectordb/entities/search" export const method = "post" diff --git a/API_Reference_MDX/milvus-restful/v2.5.x/v2/Vector (v2)/Upsert.mdx b/API_Reference_MDX/milvus-restful/v2.5.x/v2/Vector (v2)/Upsert.mdx index 7885a39fd..7f86ae853 100644 --- a/API_Reference_MDX/milvus-restful/v2.5.x/v2/Vector (v2)/Upsert.mdx +++ b/API_Reference_MDX/milvus-restful/v2.5.x/v2/Vector (v2)/Upsert.mdx @@ -1,12 +1,20 @@ --- displayed_sidebar: restfulSidebar -sidebar_positition: 36 +sidebar_positition: 46 slug: /restful/Upsert title: "Upsert | RESTful" description: "This operation inserts new records into the database or updates existing ones. | RESTful" hide_table_of_contents: true sidebar_label: "Upsert" sidebar_custom_props: { badges: ['post']} +keywords: + - zilliz cloud + - zilliz + - cloud + - "Upsert" + - "post" + - RESTful + - API --- # Upsert @@ -15,6 +23,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":"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 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":"数据库名称。"}}},"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":1800,"message":"User hasn't authenticated"}}}}}}},"security":[]} export const endpoint = "/v2/vectordb/entities/upsert" export const method = "post"