From a5271326cea81d2bcc11ba814bf2434070ebd0e0 Mon Sep 17 00:00:00 2001 From: AnthonyTsu1984 <115786031+AnthonyTsu1984@users.noreply.github.com> Date: Fri, 6 Dec 2024 12:06:18 +0800 Subject: [PATCH] update docs Signed-off-by: AnthonyTsu1984 <115786031+AnthonyTsu1984@users.noreply.github.com> --- .../Collections/CollectionSchema/addField.md | 42 +++++ .../CollectionSchema/addFunction.md | 73 ++++++++ .../v2.5.x/v2/Collections/Function.md | 69 +++++++ .../v2.5.x/v2/Collections/FunctionType.md | 13 ++ .../v2.5.x/v2/Management/IndexParam.md | 4 +- .../v2.5.x/Collections/FunctionType.md | 14 ++ .../v2.5.x/Collections/createCollection.md | 174 +++++++++++++++++- .../v2.5.x/Management/createIndex.md | 4 +- .../milvus-sdk-node/v2.5.x/Vector/search.md | 28 +++ .../v2.5.x/MilvusClient/Function/Function.md | 4 +- .../MilvusClient/Management/add_index.md | 4 +- .../v2.5.x/v2/Collection (v2)/Create.mdx | 2 +- .../v2.5.x/v2/Collection (v2)/List.mdx | 2 +- .../v2.5.x/v2/Database (v2)/alter.mdx | 20 ++ .../v2.5.x/v2/Database (v2)/create.mdx | 20 ++ .../v2.5.x/v2/Database (v2)/describe.mdx | 20 ++ .../v2.5.x/v2/Database (v2)/drop.mdx | 20 ++ .../v2.5.x/v2/Database (v2)/list.mdx | 20 ++ .../v2.5.x/v2/Import (v2)/Get Progress.mdx | 2 +- .../v2.5.x/v2/Vector (v2)/Search.mdx | 2 +- yarn.lock | 58 ++++-- 21 files changed, 560 insertions(+), 35 deletions(-) create mode 100644 API_Reference/milvus-sdk-java/v2.5.x/v2/Collections/CollectionSchema/addFunction.md create mode 100644 API_Reference/milvus-sdk-java/v2.5.x/v2/Collections/Function.md create mode 100644 API_Reference/milvus-sdk-java/v2.5.x/v2/Collections/FunctionType.md create mode 100644 API_Reference/milvus-sdk-node/v2.5.x/Collections/FunctionType.md create mode 100644 API_Reference_MDX/milvus-restful/v2.5.x/v2/Database (v2)/alter.mdx create mode 100644 API_Reference_MDX/milvus-restful/v2.5.x/v2/Database (v2)/create.mdx create mode 100644 API_Reference_MDX/milvus-restful/v2.5.x/v2/Database (v2)/describe.mdx create mode 100644 API_Reference_MDX/milvus-restful/v2.5.x/v2/Database (v2)/drop.mdx create mode 100644 API_Reference_MDX/milvus-restful/v2.5.x/v2/Database (v2)/list.mdx diff --git a/API_Reference/milvus-sdk-java/v2.5.x/v2/Collections/CollectionSchema/addField.md b/API_Reference/milvus-sdk-java/v2.5.x/v2/Collections/CollectionSchema/addField.md index f2855e446..c40e19316 100644 --- a/API_Reference/milvus-sdk-java/v2.5.x/v2/Collections/CollectionSchema/addField.md +++ b/API_Reference/milvus-sdk-java/v2.5.x/v2/Collections/CollectionSchema/addField.md @@ -23,6 +23,9 @@ CollectionSchema.addField(AddFieldReq.builder() .maxCapacity(Integer maxCapacity) .isNullable(Boolean isNullable) .defaultValue(DataType dataType) + .enableAnalyzer(Boolean enableAnalyzer) + .enableMatch(Boolean enableMatch) + .analyzerParams(Map, analyzerParams) .build() ) @@ -110,6 +113,45 @@ CollectionSchema.addField(AddFieldReq.builder() Sets a default value for a specific field in a collection schema when creating it. This is particularly useful when you want certain fields to have an initial value even if no value is explicitly provided during data insertion. +- `enableAnalyzer(Boolean enableAnalyzer)` + + 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. + +- `enableMatch(Boolean enableMatch)` + + 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. `enableMatch` works in conjunction with `enableAnalyzer` to provide structured term-based text search, with `enableAnalyzer` handling tokenization and `enableMatch` handling the search operations on these tokens. + +- `analyzerParams(Map, analyzerParams)` + + Configures the analyzer for text processing, specifically for `DataType.VarChar` fields. This parameter configures tokenizer and filter settings, particularly for text fields used in [keyword matching](https://milvus.io/docs/keyword-match.md) or [full text search](https://milvus.io/docs/full-text-search.md). Depending on the type of analyzer, it can be configured in either of the following methods: + + - Built-in analyzer + + ```java + Map analyzerParams = new HashMap<>(); + analyzerParams.put("type", "english"); + ``` + + - `type` (*String*) - + + Pre-configured analyzer type built into Milvus, which can be used out-of-the-box by specifying its name. Possible values: `standard`, `english`, `chinese`. For more information, refer to [Standard Analyzer](https://milvus.io/docs/standard-analyzer.md), [English Analyzer](https://milvus.io/docs/english-analyzer.md), and [Chinese Analyzer](https://milvus.io/docs/chinese-analyzer.md). + + - Custom analyzer + + ```java + Map analyzerParams = new HashMap<>(); + analyzerParams.put("tokenizer", "standard"); + analyzerParams.put("filter", Collections.singletonList("lowercase")); + ``` + + - `tokenizer` (*String*) - + + Defines the tokenizer type. Possible values: `standard` (default), `whitespace`, `jieba`. For more information, refer to [Standard Tokenizer](https://milvus.io/docs/standard-tokenizer.md), [Whitespace Tokenizer](https://milvus.io/docs/whitespace-tokenizer.md), and [Jieba Tokenizer](https://milvus.io/docs/jieba-tokenizer.md). + + - `filter` (*List\*) - + + Lists filters to refine tokens produced by the tokenizer, with options for built-in filters and custom filters. For more information, refer to [Alphanumonly Filter](https://milvus.io/docs/alphanumonly-filer.md) and others. + **RETURNS:** *void* diff --git a/API_Reference/milvus-sdk-java/v2.5.x/v2/Collections/CollectionSchema/addFunction.md b/API_Reference/milvus-sdk-java/v2.5.x/v2/Collections/CollectionSchema/addFunction.md new file mode 100644 index 000000000..4e20284db --- /dev/null +++ b/API_Reference/milvus-sdk-java/v2.5.x/v2/Collections/CollectionSchema/addFunction.md @@ -0,0 +1,73 @@ +# addFunction() + +This operation adds a function to convert raw data into vector representations. + +```java +public CollectionSchema addFunction(Function function) +``` + +## Request Syntax + +```java +addFunction(Function.builder() + .functionType(FunctionType functionType) + .name(String name) + .inputFieldNames(List inputFieldNames) + .outputFieldNames(List outputFieldNames) + .description(String description) + .build()); +``` + +**BUILDER METHODS:** + +- `functionType(FunctionType functionType)` + + The type of function for processing raw data. Possible values: + + - `FunctionType.BM25`: Uses the BM25 algorithm for generating sparse embeddings from a `VARCHAR` field. + +- `name(String name)` + + The name of the function. This identifier is used to reference the function within queries and collections. + +- `inputFieldNames(List inputFieldNames)` + + The name of the field containing the raw data that requires conversion to vector representation. For functions using `FunctionType.BM25`, this parameter accepts only one field name. + +- `outputFieldNames(List outputFieldNames)` + + The name of the field where the generated embeddings will be stored. This should correspond to a vector field defined in the collection schema. For functions using `FunctionType.BM25`, this parameter accepts only one field name. + +- `description(String description)` + + A brief description of the function’s purpose. This can be useful for documentation or clarity in larger projects and defaults to an empty string. + +**RETURN TYPE:** + +*Function* + +**RETURNS:** + +A `Function` object + +**EXCEPTIONS:** + +- **MilvusClientExceptions** + + This exception will be raised when any error occurs during this operation. + +## Example + +```java +import io.milvus.common.clientenum.FunctionType; +import io.milvus.v2.service.collection.request.CreateCollectionReq.Function; + +import java.util.*; + +schema.addFunction(Function.builder() + .functionType(FunctionType.BM25) + .name("text_bm25_emb") + .inputFieldNames(Collections.singletonList("text")) + .outputFieldNames(Collections.singletonList("vector")) + .build()); +``` diff --git a/API_Reference/milvus-sdk-java/v2.5.x/v2/Collections/Function.md b/API_Reference/milvus-sdk-java/v2.5.x/v2/Collections/Function.md new file mode 100644 index 000000000..5d3a33835 --- /dev/null +++ b/API_Reference/milvus-sdk-java/v2.5.x/v2/Collections/Function.md @@ -0,0 +1,69 @@ +# Function + +A `Function` instance for generating vector embeddings from user-provided raw data in Milvus. + +```java +io.milvus.v2.service.collection.request.CreateCollectionReq.Function +``` + +## Constructor + +This constructor initializes a new `Function` instance designed to transform user's raw data into vector embeddings. This is achieved through an automated process that simplifies similarity search operations. + +```java +CreateCollectionReq.Function.builder() + .name(String name) + .description(String description) + .functionType(FunctionType functionType) + .inputFieldNames(List inputFieldNames) + .outputFieldNames(List outputFieldNames) +``` + +**BUILDER METHODS:** + +- `name(String name)` + + The name of the function. This identifier is used to reference the function within queries and collections. + +- `description(String description)` + + A brief description of the function's purpose. This can be useful for documentation or clarity in larger projects and defaults to an empty string. + +- `functionType(FunctionType functionType)` + + The type of function for processing raw data. Possible values: + + - `FunctionType.BM25`: Uses the BM25 algorithm for generating sparse embeddings from a `VARCHAR` field. + +- `inputFieldNames(List inputFieldNames)` + + The name of the field containing the raw data that requires conversion to vector representation. For functions using `FunctionType.BM25`, this parameter accepts only one field name. + +- `outputFieldNames(List outputFieldNames)` + + The name of the field where the generated embeddings will be stored. This should correspond to a vector field defined in the collection schema. For functions using `FunctionType.BM25`, this parameter accepts only one field name. + +**RETURN TYPE:** + +*Function* + +**RETURNS:** + +A `Function` object that can be registered with a Milvus collection, facilitating automatic embedding generation during data insertion. + +**EXCEPTIONS:** + +- **MilvusClientExceptions** + + This exception will be raised when any error occurs during this operation. + +## Example + +```java +CreateCollectionReq.Function.builder() + .functionType(FunctionType.BM25) + .name("text_bm25_emb") + .inputFieldNames(Collections.singletonList("text")) + .outputFieldNames(Collections.singletonList("vector")) + .build()); +``` diff --git a/API_Reference/milvus-sdk-java/v2.5.x/v2/Collections/FunctionType.md b/API_Reference/milvus-sdk-java/v2.5.x/v2/Collections/FunctionType.md new file mode 100644 index 000000000..0ad8aa93f --- /dev/null +++ b/API_Reference/milvus-sdk-java/v2.5.x/v2/Collections/FunctionType.md @@ -0,0 +1,13 @@ +# FunctionType + +This is an enumeration that provides the following constants. + +## Constants + +- BM25 + + Sets the function type to **BM25**. + +- Unknown + + Sets the function type to **Unknown**. \ No newline at end of file diff --git a/API_Reference/milvus-sdk-java/v2.5.x/v2/Management/IndexParam.md b/API_Reference/milvus-sdk-java/v2.5.x/v2/Management/IndexParam.md index bbefc9b02..073fd8bab 100644 --- a/API_Reference/milvus-sdk-java/v2.5.x/v2/Management/IndexParam.md +++ b/API_Reference/milvus-sdk-java/v2.5.x/v2/Management/IndexParam.md @@ -34,7 +34,9 @@ IndexParam.builder() - `metricType(IndexParam.MetricType metricType)` - The distance metric to use for the index. Possible values are **L2**, **IP**, **COSINE**, **HAMMING**, and **JACCARD**. + The algorithm that is used to measure similarity between vectors. Possible values: `IP`, `L2`, `COSINE`, `HAMMING`, `JACCARD`, `BM25` (used only for full text search). For more information, refer to [Metric Types](https://milvus.io/docs/metric.md). + + This is available only when the specified field is a vector field. - `extraParams(Map extraParams)` diff --git a/API_Reference/milvus-sdk-node/v2.5.x/Collections/FunctionType.md b/API_Reference/milvus-sdk-node/v2.5.x/Collections/FunctionType.md new file mode 100644 index 000000000..2ec0f0c06 --- /dev/null +++ b/API_Reference/milvus-sdk-node/v2.5.x/Collections/FunctionType.md @@ -0,0 +1,14 @@ +# FunctionType + +This is an enumeration that provides the following constants. + +## Constants + +- **BM25** = 1 + + Sets the function type to **BM25**. + +- **Unknown** = 0 + + Sets the function type to **Unknown**. + diff --git a/API_Reference/milvus-sdk-node/v2.5.x/Collections/createCollection.md b/API_Reference/milvus-sdk-node/v2.5.x/Collections/createCollection.md index fccd98269..7a2864a41 100644 --- a/API_Reference/milvus-sdk-node/v2.5.x/Collections/createCollection.md +++ b/API_Reference/milvus-sdk-node/v2.5.x/Collections/createCollection.md @@ -120,14 +120,31 @@ milvusClient.createCollection({ type_params: { dim: "8" }, + nullable: boolean, - default_value: DataType + default_value: object, + enable_analyzer: boolean, + enable_match: boolean, + analyzer_params: object + } ], num_partitions?: number, partition_key_field?: string, shards_num?: number, - timeout?: number + timeout?: number, + + functions: [ + { + name: string, + description: string, + type: FunctionType, + input_field_names: string[], + output_field_names: string[], + params: Record, + }, + ] + }) ``` @@ -221,7 +238,7 @@ milvusClient.createCollection({ The maximum lengths of a string in this field. - This is required when the **data_type** of this field is **VARCHAR**. + This is required when the **data_type** of this field is **VarChar**. - **type_params** (*object*) - @@ -237,10 +254,49 @@ milvusClient.createCollection({ For more information, refer to [Nullable & Default](https://milvus.io/docs/nullable-and-default.md). - - **default_value** (*DataType*) + - **default_value** (*object*) Sets a default value for a specific field in a collection schema when creating it. This is particularly useful when you want certain fields to have an initial value even if no value is explicitly provided during data insertion. + - **enable_analyzer** (*boolean*) - + + 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. + + - **enable_match** (*boolean*) + + 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 term-based text search, with `enable_analyzer` handling tokenization and `enable_match` handling the search operations on these tokens. + + - **analyzer_params** (*object*) + + Configures the analyzer for text processing, specifically for `VarChar` fields. This parameter configures tokenizer and filter settings, particularly for text fields used in [keyword matching](https://milvus.io/docs/keyword-match.md) or [full text search](https://milvus.io/docs/full-text-search.md). Depending on the type of analyzer, it can be configured in either of the following methods: + + - Built-in analyzer + + ```javascript + const analyzer_params: { type: 'english' }; + ``` + + - `type` (*string*) - + + Pre-configured analyzer type built into Milvus, which can be used out-of-the-box by specifying its name. Possible values: `standard`, `english`, `chinese`. For more information, refer to [Standard Analyzer](https://milvus.io/docs/standard-analyzer.md), [English Analyzer](https://milvus.io/docs/english-analyzer.md), and [Chinese Analyzer](https://milvus.io/docs/chinese-analyzer.md). + + - Custom analyzer + + ```javascript + const analyzer_params: { + "tokenizer": "standard", + "filter": ["lowercase"], + }; + ``` + + - `tokenizer` (*string*) - + + Defines the tokenizer type. Possible values: `standard` (default), `whitespace`, `jieba`. For more information, refer to [Standard Tokenizer](https://milvus.io/docs/standard-tokenizer.md), [Whitespace Tokenizer](https://milvus.io/docs/whitespace-tokenizer.md), and [Jieba Tokenizer](https://milvus.io/docs/jieba-tokenizer.md). + + - `filter` (*list*) - + + Lists filters to refine tokens produced by the tokenizer, with options for built-in filters and custom filters. For more information, refer to [Alphanumonly Filter](https://milvus.io/docs/alphanumonly-filer.md) and others. + - **num_partitions** (*number)* - The number of partitions to create in the collection. @@ -284,6 +340,32 @@ milvusClient.createCollection({ The timeout duration for this operation. Setting this to **None** indicates that this operation timeouts when any response returns or error occurs. +- **functions** (*list*) + + Converts data into vector embeddings. This function will be added to the schema of a collection. + + - **name** (*string*) + + The name of the function. This identifier is used to reference the function within queries and collections. + + - **description** (*string*) + + A brief description of the function’s purpose. This can be useful for documentation or clarity in larger projects and defaults to an empty string. + + - **type** (*[FunctionType](FunctionType.md)*) + + The type of function for processing raw data. Possible values: + + - `FunctionType.BM25`: Uses the BM25 algorithm for generating sparse embeddings from a `VARCHAR` field. + + - **input_field_names** (*string[]*) + + The name of the field containing the raw data that requires conversion to vector representation. For functions using `FunctionType.BM25`, this parameter accepts only one field name. + + - **output_field_names** (*string[]*) + + The name of the field where the generated embeddings will be stored. This should correspond to a vector field defined in the collection schema. For functions using `FunctionType.BM25`, this parameter accepts only one field name. + ### With CreateCollectionWithSchemaAndIndexParamsReq Using this request body, you can customize the schema and index settings of the collection. Upon creation, the collection is automatically loaded. @@ -302,8 +384,13 @@ milvusClient.createCollection({ type_params: { dim: "8" }, + nullable: boolean, - default_value: DataType + default_value: object, + enable_analyzer: boolean, + enable_match: boolean, + analyzer_params: object + } ], num_partitions?: number, @@ -318,7 +405,19 @@ milvusClient.createCollection({ metric_type?: string, params?: keyValueObj } + ], + + functions: [ + { + name: string, + description: string, + type: FunctionType, + input_field_names: string[], + output_field_names: string[], + params: Record, + }, ] + }) ``` @@ -430,6 +529,45 @@ milvusClient.createCollection({ Sets a default value for a specific field in a collection schema when creating it. This is particularly useful when you want certain fields to have an initial value even if no value is explicitly provided during data insertion. + - **enable_analyzer** (*boolean*) - + + 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. + + - **enable_match** (*boolean*) + + 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 term-based text search, with `enable_analyzer` handling tokenization and `enable_match` handling the search operations on these tokens. + + - **analyzer_params** (*object*) + + Configures the analyzer for text processing, specifically for `VarChar` fields. This parameter configures tokenizer and filter settings, particularly for text fields used in [keyword matching](https://milvus.io/docs/keyword-match.md) or [full text search](https://milvus.io/docs/full-text-search.md). Depending on the type of analyzer, it can be configured in either of the following methods: + + - Built-in analyzer + + ```javascript + const analyzer_params: { type: 'english' } + ``` + + - `type` (*string*) - + + Pre-configured analyzer type built into Milvus, which can be used out-of-the-box by specifying its name. Possible values: `standard`, `english`, `chinese`. For more information, refer to [Standard Analyzer](https://milvus.io/docs/standard-analyzer.md), [English Analyzer](https://milvus.io/docs/english-analyzer.md), and [Chinese Analyzer](https://milvus.io/docs/chinese-analyzer.md). + + - Custom analyzer + + ```javascript + const analyzer_params: { + "tokenizer": "standard", + "filter": ["lowercase"], + } + ``` + + - `tokenizer` (*string*) - + + Defines the tokenizer type. Possible values: `standard` (default), `whitespace`, `jieba`. For more information, refer to [Standard Tokenizer](https://milvus.io/docs/standard-tokenizer.md), [Whitespace Tokenizer](https://milvus.io/docs/whitespace-tokenizer.md), and [Jieba Tokenizer](https://milvus.io/docs/jieba-tokenizer.md). + + - `filter` (*list*) - + + Lists filters to refine tokens produced by the tokenizer, with options for built-in filters and custom filters. For more information, refer to [Alphanumonly Filter](https://milvus.io/docs/alphanumonly-filer.md) and others. + - **num_partitions** (*number)* - The number of partitions to create in the collection. @@ -497,6 +635,32 @@ milvusClient.createCollection({ Extra index-related parameters in key-value pairs. +- **functions** (*list*) + + Converts data into vector embeddings. This function will be added to the schema of a collection. + + - **name** (*string*) + + The name of the function. This identifier is used to reference the function within queries and collections. + + - **description** (*string*) + + A brief description of the function’s purpose. This can be useful for documentation or clarity in larger projects and defaults to an empty string. + + - **type** (*[FunctionType](FunctionType.md)*) + + The type of function for processing raw data. Possible values: + + - `FunctionType.BM25`: Uses the BM25 algorithm for generating sparse embeddings from a `VARCHAR` field. + + - **input_field_names** (*string[]*) + + The name of the field containing the raw data that requires conversion to vector representation. For functions using `FunctionType.BM25`, this parameter accepts only one field name. + + - **output_field_names** (*string[]*) + + The name of the field where the generated embeddings will be stored. This should correspond to a vector field defined in the collection schema. For functions using `FunctionType.BM25`, this parameter accepts only one field name. + **RETURNS** *Promise\* This method returns a promise that resolves to a **ResStatus** object. diff --git a/API_Reference/milvus-sdk-node/v2.5.x/Management/createIndex.md b/API_Reference/milvus-sdk-node/v2.5.x/Management/createIndex.md index 155c488a2..76cac1c71 100644 --- a/API_Reference/milvus-sdk-node/v2.5.x/Management/createIndex.md +++ b/API_Reference/milvus-sdk-node/v2.5.x/Management/createIndex.md @@ -46,7 +46,9 @@ milvusClient.createIndex([ - **metric_type** (*string*) - - The metric type used to measure vector distance. + The metric type used to measure vector distance. Possible values: `IP`, `L2`, `COSINE`, `HAMMING`, `JACCARD`, `BM25` (used only for full text search). For more information, refer to [Metric Types](https://milvus.io/docs/metric.md). + + This is available only when the specified field is a vector field. - **params** (*string*) - diff --git a/API_Reference/milvus-sdk-node/v2.5.x/Vector/search.md b/API_Reference/milvus-sdk-node/v2.5.x/Vector/search.md index 1b15a3e54..c899a66cf 100644 --- a/API_Reference/milvus-sdk-node/v2.5.x/Vector/search.md +++ b/API_Reference/milvus-sdk-node/v2.5.x/Vector/search.md @@ -79,6 +79,34 @@ milvusClient.search({ The additional search parameters in key-value pairs. + - **radius** (*number*) - + + 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**. + + - **range_filter** (*number*) - + + 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**. + + - **max_empty_result_buckets** (*number*) + + This param is only used for range search for IVF-serial indexes, including **BIN_IVF_FLAT**, **IVF_FLAT**, **IVF_SQ8**, **IVF_PQ**, and **SCANN**. The value defaults to 1 and ranges from 1 to 65536. + + During range search, the search process terminates early if the number of buckets with no valid range search results reaches the specified value. Increasing this parameter improves range search recall. + + - **output_fields** (*string[]*) - + + A list of field names to include in each entity in return. + + The value defaults to **None**. If left unspecified, only the primary field is included. + + - **partition_names** (*string[]*) - + + A list of the names of the partitions to search. + + - **timeout** (*number*) - + + The timeout duration for this operation. Setting this to **None** indicates that this operation timeouts when any response arrives or any error occurs. + - **output_fields** (*string[]*) - A list of field names to include in each entity in return. diff --git a/API_Reference/pymilvus/v2.5.x/MilvusClient/Function/Function.md b/API_Reference/pymilvus/v2.5.x/MilvusClient/Function/Function.md index 2427220eb..46e42e321 100644 --- a/API_Reference/pymilvus/v2.5.x/MilvusClient/Function/Function.md +++ b/API_Reference/pymilvus/v2.5.x/MilvusClient/Function/Function.md @@ -1,6 +1,6 @@ # Function -A `Function` instance for generating vector embeddings from user-provided raw text data in Milvus. +A `Function` instance for generating vector embeddings from user-provided raw data in Milvus. ```python class pymilvus.Function @@ -27,7 +27,7 @@ Function( **[REQUIRED]** - The name of the function. This identifier is used to reference the function within queries and collections. + The name of the function. This identifier is used to reference the function within queries and collections. - `function_type` (*FunctionType*) - diff --git a/API_Reference/pymilvus/v2.5.x/MilvusClient/Management/add_index.md b/API_Reference/pymilvus/v2.5.x/MilvusClient/Management/add_index.md index ac4991d0c..ee8ed8556 100644 --- a/API_Reference/pymilvus/v2.5.x/MilvusClient/Management/add_index.md +++ b/API_Reference/pymilvus/v2.5.x/MilvusClient/Management/add_index.md @@ -30,9 +30,9 @@ IndexParams.add_index( - **metric_type** (*str*) - - The algorithm that is used to measure similarity between vectors. Possible values: `IP`, `L2`, `COSINE`, `HAMMING`, `JACCARD`, `BM25`. For more information, refer to [Metric Types](https://milvus.io/docs/metric.md). + The algorithm that is used to measure similarity between vectors. Possible values: `IP`, `L2`, `COSINE`, `HAMMING`, `JACCARD`, `BM25` (used only for full text search). For more information, refer to [Metric Types](https://milvus.io/docs/metric.md). - This is available only when the specified field is a vector field. + This is available only when the specified field is a vector field. - **params** (*dict*) - 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 824dd5652..296392e15 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 @@ -15,6 +15,6 @@ import RestSpecs from '@site/src/components/RestSpecs'; -export const specs = {"summary":"Create Collection","deprecated":false,"description":"This operation creates a collection in a specified cluster.","x-i18n":{"zh-CN":{"summary":"创建 Collection","description":"本接口可在指定集群中创建 Collection。"}},"tags":["Collection Operations (V2)"],"parameters":[{"name":"Authorization","in":"header","description":"The authentication token should be an API key with appropriate privileges or a pair of colon-joined username and password, like `username:password`.","required":true,"example":"Bearer {{TOKEN}}","schema":{"type":"string"},"x-i18n":{"zh-CN":{"description":"认证令牌，应为具备适当权限的 API 密钥或用冒号分隔的用户名和密码，如 `username:password`。"}}}],"requestBody":{"content":{"application/json":{"schema":{"description":"Creates a collection in either the quick-setup mode or the custom-setup mode. \n\nIn the quick-setup mode, the schema of the created collection has two schema-defined fields named `id` and `vector` and enabled the dynamic field feature. \n\nIn the custom-setup mode, the schema is defined by the user and the dynamic field feature is disabled by default.","x-i18n":{"zh-CN":{"description":"支持使用快速建表方式和自定义建表方式创建 Collection。\n\n在快速建表方式下，创建的 Collection 具有两个由 Schema 定义的字段 `id` 和 `vector`，并启用了动态字段功能。\n\n在自定义建表方式下，用户可以自定义 Collection 的 Schema，并默认禁用了动态字段功能。"}},"oneOf":[{"x-tab-label":"quick setup","type":"object","properties":{"dbName":{"type":"string","description":"The name of the database.","x-i18n":{"zh-CN":{"description":"数据库名称。"}},"x-include-target":["milvus"]},"collectionName":{"type":"string","description":"The name of the collection to create.","x-i18n":{"zh-CN":{"description":"待创建 Collection 的名称。"}}},"dimension":{"type":"integer","description":"The number of dimensions a vector value should have.\nThis is required if **dtype** of this field is set to **DataType.FLOAT_VECTOR** or **DataType.Binary_VECTOR.","x-i18n":{"zh-CN":{"description":"向量值的维度数。\n若该字段的 **dtype** 为 **DataType.FLOAT_VECTOR** 或 **DataType.Binary_VECTOR，则该字段为必填项。"}}},"metricType":{"type":"string","description":"The metric type applied to this operation.","x-i18n":{"zh-CN":{"description":"当前 Collection 的度量类型。"}},"enum":["L2","IP","COSINE"],"default":"COSINE"},"idType":{"type":"string","description":"The data type of the primary field. This parameter is designed for the quick-setup of a collection and will be ignored if __schema__ is defined.","x-i18n":{"zh-CN":{"description":"主键字段数据类型。该参数为快速创建 Collection 而设计，若您已定义 __schema__ 字段，则该参数将被忽略。"}}},"autoID":{"type":"string","default":"false","description":"Whether the primary field automatically increments. This parameter is designed for the quick-setup of a collection and will be ignored if __schema__ is defined.","x-i18n":{"zh-CN":{"description":"主键是否自动增长。该参数为快速创建 Collection 而设计，若您已定义 __schema__ 字段，则该参数将被忽略。"}}},"primaryFieldName":{"type":"string","description":"The name of the primary field. This parameter is designed for the quick-setup of a collection and will be ignored if __schema__ is defined.","x-i18n":{"zh-CN":{"description":"主键字段名称。该参数为快速创建 Collection 而设计，若您已定义 __schema__ 字段，则该参数将被忽略。"}}},"vectorFieldName":{"type":"string","description":"The name of the vector field. This parameter is designed for the quick-setup of a collection and will be ignored if __schema__ is defined.","x-i18n":{"zh-CN":{"description":"向量字段名称。该参数为快速创建 Collection 而设计，若您已定义 __schema__ 字段，则该参数将被忽略。"}}}},"required":["collectionName","dimension"]},{"x-tab-label":"custom setup","type":"object","properties":{"dbName":{"type":"string","description":"The name of the database.","x-i18n":{"zh-CN":{"description":"数据库名称。"}},"x-include-target":["milvus"]},"collectionName":{"type":"string","description":"The name of the collection to create.","x-i18n":{"zh-CN":{"description":"待创建 Collection 的名称。"}}},"schema":{"description":"The schema is responsible for organizing data in the target collection. A valid schema should have multiple fields, which must include a primary key, a vector field, and several scalar fields. Setting this parameter means that `dimension`, `idType`, `autoID`, `primaryFieldName`, and `vectorFieldName` will be ignored.","x-i18n":{"zh-CN":{"description":"Schema 决定了 Collection 中数据的组织方式。一个有效的 Schema 应包含多个字段，其中必须包含主键字段、向量字段以及多个标量字段。设置本参数时，`dimension`、 `idType`、`autoID`、`primaryFieldName`、`vectorFieldName` 等参数将被忽略。"}},"type":"object","properties":{"autoID":{"type":"string","description":"Whether allows the primary field to automatically increment. Setting this to True makes the primary field automatically increment. In this case, the primary field should not be included in the data to insert to avoid errors. Set this parameter in the field with is_primary set to True.","x-i18n":{"zh-CN":{"description":"是否允许主键字段自动增长。将该参数设置为 `True` 则主键字段将自动增长。在这种情况下，请不要在插入数据时包含主键字段，以避免错误。如果当前字段的 `is_primary` 参数设置为 `True`，则本参数为必填项。"}}},"enableDynamicField":{"type":"string","description":"Whether allows to use the reserved __$meta__ field to hold non-schema-defined fields in key-value pairs.","x-i18n":{"zh-CN":{"description":"是否允许使用保留字段 __$meta__ 来保存 Schema 中未定义的字段。"}}},"fields":{"type":"array","items":{"description":"A field object","type":"object","properties":{"fieldName":{"type":"string","description":"The name of the field to create in the target collection","x-i18n":{"zh-CN":{"description":"目标 Collection 中待创建的字段名称。"}}},"dataType":{"type":"string","description":"The data type of the field values.","x-i18n":{"zh-CN":{"description":"字段值的数据类型。"}},"enum":["DataType.BOOL","DataType.INT8","DataType.INT16","DataType.INT32","DataType.INT64","DataType.FLOAT","DataType.DOUBLE","DataType.VARCHAR","DataType.ARRAY","DataType.JSON","DataType.BINARY_VECTOR","DataType.FLOAT_VECTOR","DataType.FLOAT16_VECTOR","DataType.BFLOAT16_VECTOR","DataType.SPARSE_FLOAT_VECTOR"]},"elementDataType":{"type":"string","description":"The data type of the elements in an array field. This is required if the current field is of the array type.","x-i18n":{"zh-CN":{"description":"数组字段中各元素的数据类型。若当前字段为数组类型，则该参数为必填项。"}},"enum":["DataType.BOOL","DataType.INT8","DataType.INT16","DataType.INT32","DataType.INT64","DataType.FLOAT","DataType.DOUBLE","DataType.VARCHAR"]},"isPrimary":{"type":"boolean","description":"Whether the current field is the primary field. Setting this to True makes the current field the primary field.","x-i18n":{"zh-CN":{"description":"当前字段是否为主键字段。将该参数设置为 `True` 则当前字段将成为主键字段。此时，还需要确定 `autoID` 参数的取值。"}}},"isPartitionKey":{"type":"boolean","description":"Whether the current field serves as the partition key. Setting this to True makes the current field serve as the partition key. In this case, MilvusZilliz Cloud manages all partitions in the current collection.","x-i18n":{"zh-CN":{"description":"当前字段是否为 Partition Key。将该参数设置为 `True` 则当前字段将作为 Partition Key。在这种情况下，MilvusZilliz Cloud 会管理当前 Collection 中的所有 Partition。"}}},"elementTypeParams":{"type":"object","properties":{"max_length":{"type":"integer","description":"An optional parameter for VarChar values that determines the maximum length of the value in the current field.","x-i18n":{"zh-CN":{"description":"如果当前字段的数据类型为 VarChar，则该参数为必填项，用于设置该字段值的最大长度。"}}},"dim":{"type":"integer","description":"An optional parameter for FloatVector or BinaryVector fields that determines the vector dimension.","x-i18n":{"zh-CN":{"description":"如果当前字段的数据类型为 FloatVector 或 BinaryVector，则该参数为必填项，用于设置向量维度。"}}},"max_capacity":{"type":"integer","description":"An optional parameter for Array field values that determines the maximum number of elements in the current array field.","x-i18n":{"zh-CN":{"description":"如果当前字段的数据类型为 Array，则该参数为必填项，用于设置该字段值的最大元素数量。"}}}},"description":"Extra field parameters.","x-i18n":{"zh-CN":{"description":"字段附加参数。"}}}},"required":["fieldName","dataType"]},"description":"A list of field objects.","x-i18n":{"zh-CN":{"description":"字段列表。"}}}},"required":["fields"]},"indexParams":{"type":"array","items":{"type":"object","properties":{"metricType":{"type":"string","description":"The similarity metric type used to build the index. For more information, refer to Similarity Metrics Explained](/docs/search-metrics-explained)Similarity Metrics](https://milvus.io/docs/metric.md).","x-i18n":{"zh-CN":{"description":"用于构建索引的相似度类型。更多详情，请参考相似度指标详解相似度指标](https://milvus.io/docs/metric.md)。"}},"enum":["L2","IP","COSINE"],"default":"COSINE"},"fieldName":{"type":"string","description":"The name of the target field on which an index is to be created.","x-i18n":{"zh-CN":{"description":"要创建索引的目标字段名称。"}}},"indexName":{"type":"string","description":"The name of the index to create. The value defaults to the target field name.","x-i18n":{"zh-CN":{"description":"要创建的索引名称。该值默认为目标字段名称。"}}},"params":{"description":"The index type and related settings. For details, refer to [Vector Indexes](https://milvus.io/docs/index.md).For Zilliz Cloud clusters, you should always set `index_type` to `AUTOINDEX`.","x-i18n":{"zh-CN":{"description":"索引类型及相关设置。详细信息请参考[向量索引](https://milvus.io/docs/index.md)对于 Zilliz Cloud 集群而言，请始终将 `index_type` 设置成 `AUTOINDEX`。"}},"type":"object","properties":{"index_type":{"type":"string","description":"The type of the index to create","x-i18n":{"zh-CN":{"description":"要创建的索引类型。对于 Zilliz Cloud 集群而言，请始终将 `index_type` 设置成 `AUTOINDEX`"}}},"M":{"type":"integer","description":"The maximum degree of the node. This applies only when **index_type** is set to __HNSW__.","x-i18n":{"zh-CN":{"description":"数据节点与其他节点连接的边数。此参数仅适用于**索引类型**为 __HNSW__ 的情况。"}},"x-include-target":["milvus"]},"efConstruction":{"type":"integer","description":"The search scope. This applies only when **index_type** is set to __HNSW__.","x-i18n":{"zh-CN":{"description":"搜索范围。此参数仅适用于**索引类型**为 __HNSW__ 的情况。"}},"x-include-target":["milvus"]},"nlist":{"type":"integer","description":"The number of cluster units. This applies only when **index_type** is set to __IVF-related__ index types.","x-i18n":{"zh-CN":{"description":"数据集群单元的数量。此参数仅适用于**索引类型**为 __IVF__ 系列索引的情况。"}},"x-include-target":["milvus"]}},"x-i18n-langs":["zh-CN"],"required":["index_type"]}},"x-i18n-langs":["zh-CN"],"required":["metricType","fieldName","indexName"]},"description":"The parameters that apply to the index-building process.","x-i18n":{"zh-CN":{"description":"索引构建所需相关参数。"}}},"params":{"description":"Extra parameters for the collection.","x-i18n":{"zh-CN":{"description":"创建 Collection 的附加参数。"}},"type":"object","properties":{"max_length":{"type":"integer","description":"The maximum number of characters in a VarChar field. This parameter is mandatory when the current field type is VarChar.","x-i18n":{"zh-CN":{"description":"设置 VarChar 字段的最大长度。如果当前字段类型为 VarChar 时，该参数为必填项。"}}},"enableDynamicField":{"type":"boolean","description":"Whether to enable the reserved dynamic field. If set to true, non-schema-defined fields are saved in the reserved dynamic field as key-value pairs.","x-i18n":{"zh-CN":{"description":"是否启用保留的动态字段。如果设置为 `true`，则非 Schema 定义的字段将以键值对的形式保存被保存到保留的动态字段中。"}}},"shardsNum":{"type":"integer","description":"The number of shards to create along with the current collection.","x-i18n":{"zh-CN":{"description":"随当前 Collection 创建的 Shard 数量。"}},"x-include-target":["milvus"]},"consistencyLevel":{"type":"integer","description":"The consistency level of the collection.","x-i18n":{"zh-CN":{"description":"当前 Collection 的一致性级别。"}},"enum":["STRONG","BOUNDED","SESSION","EVENTUALLY"]},"partitionsNum":{"type":"integer","description":"The number of partitions to create along with the current collection. This parameter is mandatory if one field of the collection has been designated as the partition key.","x-i18n":{"zh-CN":{"description":"随当前 Collection 创建的 Partition 数量。如果当前 Collection 中有指定为 Partition Key 的字段，则该参数为必填项。"}}},"ttlSeconds":{"type":"integer","description":"The time-to-live (TTL) period of the collection. If set, the collection is to be dropped once the period ends.","x-i18n":{"zh-CN":{"description":"当前 Collection 的 TTL 时间。如果设置，则在 TTL 时间结束后，该 Collection 将被删除。"}}}}}}}],"required":["collectionName"]},"examples":{"1":{"summary":"Quick setup","x-target-request":"OPTION 1","value":{"collectionName":"test_collection","dimension":5}},"2":{"summary":"Quick setup with custom fields","x-target-request":"OPTION 1","value":{"collectionName":"custom_quick_setup","dimension":5,"primaryFieldName":"my_id","idType":"VarChar","vectorFieldName":"my_vector","metric_type":"L2","autoId":true,"params":{"max_length":"512"}}},"3":{"summary":"Custom setup","x-target-request":"OPTION 2","value":{"collectionName":"custom_setup","schema":{"autoId":false,"enabledDynamicField":false,"fields":[{"fieldName":"my_id","dataType":"Int64","isPrimary":true},{"fieldName":"my_vector","dataType":"FloatVector","elementTypeParams":{"dim":"5"}}]}}},"4":{"summary":"Custom setup with index","x-target-request":"OPTION 2","x-include-target":["zilliz"],"value":{"collectionName":"custom_setup_indexed","schema":{"autoId":false,"enabledDynamicField":false,"fields":[{"fieldName":"my_id","dataType":"Int64","isPrimary":true},{"fieldName":"my_vector","dataType":"FloatVector","elementTypeParams":{"dim":"5"}}]},"indexParams":[{"fieldName":"my_vector","metricType":"COSINE","indexName":"my_vector","params":{"index_type":"AUTOINDEX"}},{"fieldName":"my_id","indexName":"my_id","params":{"index_type":"STL_SORT"}}]}},"5":{"summary":"Custom setup with index","x-target-request":"OPTION 2","x-include-target":["milvus"],"value":{"collectionName":"custom_setup_indexed","schema":{"autoId":false,"enabledDynamicField":false,"fields":[{"fieldName":"my_id","dataType":"Int64","isPrimary":true},{"fieldName":"my_vector","dataType":"FloatVector","elementTypeParams":{"dim":"5"}}]},"indexParams":[{"fieldName":"my_vector","metricType":"COSINE","indexName":"my_vector","params":{"index_type":"IVF_FLAT","nlist":1024}},{"fieldName":"my_id","indexName":"my_id","params":{"index_type":"STL_SORT"}}]}}}}}},"responses":{"200":{"description":"Returns a collection object.","x-i18n":{"zh-CN":{"description":"返回 Collection 对象。"}},"content":{"application/json":{"schema":{"anyOf":[{"x-tab-label":"success","type":"object","properties":{"code":{"type":"integer","description":"Response code.","x-i18n":{"zh-CN":{"description":"响应码。"}}},"data":{"type":"object","description":"Response payload which is an empty object.","x-i18n":{"zh-CN":{"description":"响应负载，为空对象。"}},"properties":{}}}},{"x-tab-label":"failure","description":"A failure response.","x-i18n":{"zh-CN":{"description":"失败响应。"}},"x-i18n-langs":["zh-CN"],"type":"object","properties":{"code":{"type":"integer","description":"Response code.","x-i18n":{"zh-CN":{"description":"响应码。"}}},"message":{"type":"string","description":"Error message.","x-i18n":{"zh-CN":{"description":"错误描述。"}}}}}]},"examples":{"1":{"summary":"success","x-target-response":"OPTION 1","value":{"code":0,"data":{}}},"2":{"summary":"failure","x-target-response":"OPTION 2","value":{"code":0,"message":"The token is illegal."}}}}}}},"security":[]} +export const 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 endpoint = "/v2/vectordb/collections/create" 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 b3e4d9041..c81eab2c8 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 @@ -15,6 +15,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":"现有数据库名称。"}},"x-include-target":["milvus"]}}},"examples":{"1":{"summary":"milvus","x-include-target":["milvus"],"value":{"dbName":"_default"}},"2":{"summary":"zilliz","x-include-target":["zilliz"],"value":{}}}}}},"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":0,"message":"The token is illegal."}}}}}}},"security":[]} export const endpoint = "/v2/vectordb/collections/list" 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 new file mode 100644 index 000000000..154de0175 --- /dev/null +++ b/API_Reference_MDX/milvus-restful/v2.5.x/v2/Database (v2)/alter.mdx @@ -0,0 +1,20 @@ +--- +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.mdx b/API_Reference_MDX/milvus-restful/v2.5.x/v2/Database (v2)/create.mdx new file mode 100644 index 000000000..ee002776f --- /dev/null +++ b/API_Reference_MDX/milvus-restful/v2.5.x/v2/Database (v2)/create.mdx @@ -0,0 +1,20 @@ +--- +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.mdx b/API_Reference_MDX/milvus-restful/v2.5.x/v2/Database (v2)/describe.mdx new file mode 100644 index 000000000..5da35b4ea --- /dev/null +++ b/API_Reference_MDX/milvus-restful/v2.5.x/v2/Database (v2)/describe.mdx @@ -0,0 +1,20 @@ +--- +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.mdx b/API_Reference_MDX/milvus-restful/v2.5.x/v2/Database (v2)/drop.mdx new file mode 100644 index 000000000..51f9a9714 --- /dev/null +++ b/API_Reference_MDX/milvus-restful/v2.5.x/v2/Database (v2)/drop.mdx @@ -0,0 +1,20 @@ +--- +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.mdx b/API_Reference_MDX/milvus-restful/v2.5.x/v2/Database (v2)/list.mdx new file mode 100644 index 000000000..fe169f3cd --- /dev/null +++ b/API_Reference_MDX/milvus-restful/v2.5.x/v2/Database (v2)/list.mdx @@ -0,0 +1,20 @@ +--- +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)/Get Progress.mdx b/API_Reference_MDX/milvus-restful/v2.5.x/v2/Import (v2)/Get Progress.mdx index 67da94f17..dafbaa7fd 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 @@ -15,6 +15,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":{"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":0,"message":"The token 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/Vector (v2)/Search.mdx b/API_Reference_MDX/milvus-restful/v2.5.x/v2/Vector (v2)/Search.mdx index 5e58a5973..9a668c8d5 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 @@ -15,6 +15,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":"数据库名称。"}},"x-include-target":["milvus"]},"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。"}}}},"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":"充当分组聚合条件的字段名称。"}}},"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 endpoint = "/v2/vectordb/entities/search" export const method = "post" diff --git a/yarn.lock b/yarn.lock index 3b793c12a..20628fd00 100644 --- a/yarn.lock +++ b/yarn.lock @@ -23,7 +23,7 @@ resolved "https://registry.npmmirror.com/@babel/compat-data/-/compat-data-7.25.4.tgz" integrity sha512-+LGRog6RAsCJrrrg/IO6LGmpphNe5DiK30dGjCoxxeGv49B10/3XYGxPsAwrDlMFcFEvdAUavDT8r9k/hSyQqQ== -"@babel/core@^7.25.2": +"@babel/core@^7.0.0", "@babel/core@^7.0.0-0", "@babel/core@^7.25.2": version "7.25.2" resolved "https://registry.npmmirror.com/@babel/core/-/core-7.25.2.tgz" integrity sha512-BBt3opiCOxUr9euZ5/ro/Xv8/V7yJ5bjYMqG/C1YAo8MIKAnumZalCN+msbci3Pigy4lIQfPUpfMM27HMGaYEA== @@ -344,6 +344,19 @@ resolved "https://registry.npmmirror.com/@types/ms/-/ms-0.7.34.tgz" integrity sha512-nG96G3Wp6acyAgJqGasjODb+acrI7KltPiRxzHPXnP3NgI28bpQDRv53olbqGXbfcgF5aiiHmO3xpwEpS5Ld9g== +"@types/prop-types@*": + version "15.7.13" + resolved "https://registry.npmmirror.com/@types/prop-types/-/prop-types-15.7.13.tgz" + integrity sha512-hCZTSvwbzWGvhqxp/RqVqwU999pBf2vp7hzIjiYOsl8wqOmUxkQ6ddw1cV3l8811+kdUFus/q4d1Y3E3SyEifA== + +"@types/react@>=16": + version "18.3.8" + resolved "https://registry.npmmirror.com/@types/react/-/react-18.3.8.tgz" + integrity sha512-syBUrW3/XpnW4WJ41Pft+I+aPoDVbrBVQGEnbD7NijDGlVC+8gV/XKRY+7vMDlfPpbwYt0l1vd/Sj8bJGMbs9Q== + dependencies: + "@types/prop-types" "*" + csstype "^3.0.2" + "@types/unist@*", "@types/unist@^3.0.0": version "3.0.3" resolved "https://registry.npmmirror.com/@types/unist/-/unist-3.0.3.tgz" @@ -369,7 +382,7 @@ acorn-jsx@^5.0.0: resolved "https://registry.npmmirror.com/acorn-jsx/-/acorn-jsx-5.3.2.tgz" integrity sha512-rq9s+JNhf0IChjtDXxllJ7g41oZk5SlXtp0LHwyA5cejwn7vKmKp4pPri6YEePv2PU65sAsegbXtIinmDFDXgQ== -acorn@^8.0.0: +"acorn@^6.0.0 || ^7.0.0 || ^8.0.0", acorn@^8.0.0: version "8.12.1" resolved "https://registry.npmmirror.com/acorn/-/acorn-8.12.1.tgz" integrity sha512-tcpGyI9zbizT9JbV6oYE477V6mTlXvvi0T0G3SNIYE2apm/G5huBa1+K89VGeovbg+jycCrfhl3ADxErOuO6Jg== @@ -431,7 +444,7 @@ boolbase@^1.0.0: resolved "https://registry.npmmirror.com/boolbase/-/boolbase-1.0.0.tgz" integrity sha512-JZOSA7Mo9sNGB8+UjSgzdLtokWAky1zbztM3WRLCbZ70/3cTANmQmOdR7y2g+J0e2WXywy1yS468tY+IruqEww== -browserslist@^4.23.1: +browserslist@^4.23.1, "browserslist@>= 4.21.0": version "4.23.3" resolved "https://registry.npmmirror.com/browserslist/-/browserslist-4.23.3.tgz" integrity sha512-btwCFJVjI4YWDNfau8RhZ+B1Q/VLoUITrm3RlP6y1tYGWIOa+InuYiRGXUBXo8nA1qKmHMyLB/iVQg5TT4eFoA== @@ -542,6 +555,11 @@ cssstyle@^4.0.1: dependencies: rrweb-cssom "^0.6.0" +csstype@^3.0.2: + version "3.1.3" + resolved "https://registry.npmmirror.com/csstype/-/csstype-3.1.3.tgz" + integrity sha512-M1uQkMl8rQK/szD0LNhtqxIPLpimGm8sOBwU7lLnCpSbTyY3yeU1Vc7l4KT5zT4s/yOxHH5O7tIuuLOCnLADRw== + data-urls@^5.0.0: version "5.0.0" resolved "https://registry.npmmirror.com/data-urls/-/data-urls-5.0.0.tgz" @@ -550,7 +568,7 @@ data-urls@^5.0.0: whatwg-mimetype "^4.0.0" whatwg-url "^14.0.0" -debug@4, debug@^4.0.0, debug@^4.1.0, debug@^4.3.1, debug@^4.3.4: +debug@^4.0.0, debug@^4.1.0, debug@^4.3.1, debug@^4.3.4, debug@4: version "4.3.6" resolved "https://registry.npmmirror.com/debug/-/debug-4.3.6.tgz" integrity sha512-O/09Bd4Z1fBrU4VzkhFqVgpPzaGbw6Sm9FEkBT1A/YBXQFGuuSxa1dN2nxgxS34JmKXqYx8CZAwEVoJFImUXIg== @@ -586,14 +604,6 @@ devlop@^1.0.0, devlop@^1.1.0: dependencies: dequal "^2.0.0" -dom-serializer@0: - version "0.2.2" - resolved "https://registry.npmmirror.com/dom-serializer/-/dom-serializer-0.2.2.tgz" - integrity sha512-2/xPb3ORsQ42nHYiSunXkDjPLBaEj/xTwUO4B7XCZQTRk7EBtTOPaygh10YAAh2OI1Qrp6NWfpAhzswj0ydt9g== - dependencies: - domelementtype "^2.0.1" - entities "^2.0.0" - dom-serializer@^1.0.1: version "1.4.1" resolved "https://registry.npmmirror.com/dom-serializer/-/dom-serializer-1.4.1.tgz" @@ -603,7 +613,15 @@ dom-serializer@^1.0.1: domhandler "^4.2.0" entities "^2.0.0" -domelementtype@1, domelementtype@^1.3.1: +dom-serializer@0: + version "0.2.2" + resolved "https://registry.npmmirror.com/dom-serializer/-/dom-serializer-0.2.2.tgz" + integrity sha512-2/xPb3ORsQ42nHYiSunXkDjPLBaEj/xTwUO4B7XCZQTRk7EBtTOPaygh10YAAh2OI1Qrp6NWfpAhzswj0ydt9g== + dependencies: + domelementtype "^2.0.1" + entities "^2.0.0" + +domelementtype@^1.3.1, domelementtype@1: version "1.3.1" resolved "https://registry.npmmirror.com/domelementtype/-/domelementtype-1.3.1.tgz" integrity sha512-BSKB+TSpMpFI/HOxCNr1O8aMOTZ8hT3pM3GQ0w/mWRmkhEDSFJkkyzz4XQsBV44BChwGkrDfMyjVD0eA2aFV3w== @@ -853,7 +871,7 @@ hast-util-whitespace@^3.0.0: dependencies: "@types/hast" "^3.0.0" -he@1.2.0, he@^1.0.0: +he@^1.0.0, he@1.2.0: version "1.2.0" resolved "https://registry.npmmirror.com/he/-/he-1.2.0.tgz" integrity sha512-F/1DnUGPopORZi0ni+CvrCgHQ5FyEAHRLSApuYWMmrbSwoN2Mn/7k+Gl38gJnR7yyDZk6WLXwiGod1JOWNDKGw== @@ -929,16 +947,16 @@ iconv-lite@0.6.3: dependencies: safer-buffer ">= 2.1.2 < 3.0.0" -inherits@2.0.3: - version "2.0.3" - resolved "https://registry.npmmirror.com/inherits/-/inherits-2.0.3.tgz" - integrity sha512-x00IRNXNy63jwGkJmzPigoySHbaqpNuzKbBOmzK+g2OdZpQ9w+sxCN+VSB3ja7IAge2OP2qpfxTjeNcyjmW1uw== - inherits@^2.0.1, inherits@^2.0.3: version "2.0.4" resolved "https://registry.npmmirror.com/inherits/-/inherits-2.0.4.tgz" integrity sha512-k/vGaX4/Yla3WzyMCvTQOXYeIHvqOKtnqBduzTHpzpQZzAskKMhZ2K+EnBiSM9zGSoIFeMpXKxa4dYeZIQqewQ== +inherits@2.0.3: + version "2.0.3" + resolved "https://registry.npmmirror.com/inherits/-/inherits-2.0.3.tgz" + integrity sha512-x00IRNXNy63jwGkJmzPigoySHbaqpNuzKbBOmzK+g2OdZpQ9w+sxCN+VSB3ja7IAge2OP2qpfxTjeNcyjmW1uw== + inline-style-parser@0.1.1: version "0.1.1" resolved "https://registry.npmmirror.com/inline-style-parser/-/inline-style-parser-0.1.1.tgz" @@ -1653,7 +1671,7 @@ react-dom@^18.3.1: loose-envify "^1.1.0" scheduler "^0.23.2" -react@^18.3.1: +react@^18.3.1, react@>=16: version "18.3.1" resolved "https://registry.npmmirror.com/react/-/react-18.3.1.tgz" integrity sha512-wS+hAgJShR0KhEvPJArfuPVN1+Hz1t0Y6n5jLrGQbkb4urgPE/0Rve+1kMB1v/oWgHgm4WIcV+i7F2pTVj+2iQ==